unkeyed / unkey

Open source API management platform

Unkey

Open Source API authentication and authorization

unkey.com

Contributing

Please read through our contributing guide before starting any work.

Let's talk

Authors

Stats

unkey's Issues

Introduce Teams

We need to introduce teams (organizations) so we can support multi users.

API endpoint to update a key

These fields should be updatable:

• ratelimit
• limit
• meta
• ownerId
• expires

Introduce payments

We need to introduce payments to begin the revenue stream. We don't have to enable it but at least have the code behind.

Strict ratelimiting via global consensus

nuxt

Create overview page

Create a UI for the overview pages to show the user stats, info and anything else.

Evict keys from cache not only when deleted but also when updated

temporary keys for trials

Create onboarding flow UI

Create our onboarding flow:

1. User signs up.
2. User creates their tenant
3. User lands in their tenant page.

Verify an api key via api

Issue & PR templates actions

Should I add issue & PR templates to the repo. Similar to this from the unkey-go SDK?

https://github.com/WilfredAlmeida/unkey-go/tree/main/.github

Tentative Elixir SDK

Hi I saw a tweet from @chronark https://twitter.com/chronark_/status/1671626313558261763?s=46&t=mo1Vl4m1gGQKGdXzA6KgkQ about potentially building an SDK in TS and the community building one in Elixir and I just wanted to pop in and offer to build one in Elixir for the community. I'm an engineer with 3 years experience with JS / TS and Elixir and I think the community would benefit from having a package as it's usually forgotten.

https://github.com/glamboyosa/ex-cleanse is an example of a small package I wrote in TS for Elixir.

Cheers.

[KEY-5] Introduce Teams

We need to introduce teams (organizations) so we can support multi users.

Differentiate between false and true verifications

The dashboard treats all verifications, whether the result is true or false based on the ratelimit, as the same. It might be useful to be able to keep track of the the number of true and false results and maybe even visualize this with a stacked bar chart or two columns per day, one for verifications that return true and another for the ones that return false.

Add metadata to create form

Add the ability to introduce meta to the form, so we have parity with API

Cache root key in http-only cookie or elsewhere

Right now when creating a regular key in the UI, we first create a timed root key and then use that to create the key.
it would be better if we can use a cached root key instead.

I have not found a way to set cookies with trpc, so perhaps we need a new trpc route to get a root key and then store that in the SessionStorage manually

[ui] Fix Create new API Dialog's styling.

Issue: Create Button in create new API should have some more space around it. as of now it looks so much cluttered with the text above it. Dialog's styling does not looks consistent.

😄 I am willing to fix this issue, Can I? and create the pull request right away?

To Reproduce:

• go ahead and open the create new API dialog.

Add a formatter for the metadata JSON input when creating new keys in API GUI

While the validator and error message are helpful to enforce valid JSON, a formatter would also go a long way to improve the UX of writing metadata onto keys. A formatter that adds closing parantheses/brackets/braces/quotes, new lines, indents, etc. would be great. Anything that feels more like an IDE is probably the right direction.

Not hugely important, but sharing for visibility :).

Relaxed ratelimiting in memory for each pod

Mix Project with Supervision Tree, Elixir Example

Basically an example for the Elixir community on how to use the Elixir SDK under a supervision tree as it's the most common way to build out Elixir applications.

Timeline for Availability of Usage Analytics and Policy Addition Features

Hello Maintainers,

Firstly, I want to extend my heartfelt appreciation for your diligent work on this incredible open-source project. We have evaluated several solutions and decided to integrate your product into our system due to its superior quality and functionality.

However, for our specific needs, we are particularly interested in two upcoming features: Usage Analytics and Policy Additions. They form crucial components of our intended application.

With that said, I would like to kindly inquire if you could provide us with a tentative timeline for the implementation of these features. Our project's schedule is somewhat time-sensitive, so having an estimate would greatly assist us in planning and coordination.

Thank you for your time and consideration. We are looking forward to using your project to its full potential.

[KEY-68] Ger rid of @next/font

Your project has @next/font installed as a dependency, please use the built-in next/font instead. The @next/font package will be removed in Next.js 14. You can migrate by running pnpm dlx @next/codemod@latest built-in-next-font .. Read more: https://nextjs.org/docs/messages/built-in-next-font

_{From SyncLinear.com | KEY-68}

Stale data when creating a API and coming back to the APIs page

This is a known problem with Next.js app router: vercel/next.js#42991

I open this issue because i am curious to see how you solve it 👀

One way would be to call revalidatePath but that was bugged too last time i tried it

API Sidebar is overflowing

Account Management

Allow users to:

1. Update email
2. Update profile picture
3. Delete account and all data
4. Delete Org membership
5. Delete entire Org

Multiple created APIs not visible on dashboard

Created APIs are not listed in the workspace until the page is refreshed. Please watch the following video as its hard to explain in text

unkey-bug-report.mp4

App redirected too many times

When I login using gmail, this page keeps redirecting: https://unkey.dev/app

Disable all buttons when we are creating

Make sure buttons are disabled so people don't double or triple click

Make the root API key hidden by default

For security, it would be best if the root API key were hidden like in a password field by default with the copy button and potentially a show/hide button as well.

I would be happy to contribute this.

Expires check on creation is incorect.

curl --request POST \
  --url https://api.unkey.dev/v1/keys \
  --header 'Authorization: Bearer unkey_8utaTazvpL7yXjqngegmVW' \
  --header 'Content-Type: application/json' \
  --data '{
        "apiId":"api_7oKUUscTZy22jmVf9THxDA",
        "prefix":"xyz",
        "byteLength":16,
        "ownerId":"james",
        "meta":{
                "hello": "world"
        },
        "expires": 17187186732,
        "ratelimit":{
                "type":"fast",
                "limit":10,
                "refillRate": 1,
                "refillInterval": 1000
        }

}'

This returns expires must be in the future, the date is in 2054. We should double check two things:

1. How we do comparison.
2. Make sure the timezone is always UTC

Allow creating an api key via api

Golang SDK for Unkey

I am willing to create a Go package for creating, verifying, and revoking keys.

If approved, please assign me the issue and I'll work on it.

Workspace creations causes user to be trapped in stripe

Because we want users to pay for a workspace, we trap them and they can't get out. This doesn't present in Dev because you can switch to the other workspace because it doesn't open stripe.

We should do something else to prevent this instead.

1. Disable all the buttons.
2. Allow them to move to -> app/apis (so they can go back to personal

Security questions

Hi, I would like to use Unkey in my project but I have a few questions regarding security.

• Why is Unkey secure? What makes it secure?
• Where are API keys stored? On a Planet scale db instance?
• Are the API keys encrypted in any way?

[ui] Minor UI Fix required ( Only for Firefox may be )

Issue: The Alert Triangle or Danger Icon is overlapped by the Alert Title.

Note: this issue is only seen on Firefox web browser as of now.

• Firefox
  

• Google chrome
  

nextjs

Broken Link in README file

I've found a documentation bug in the README file. When clicking on the CONTRIBUTING link, it redirects to a 404 page not found error.

It seems like the CONTRIBUTING.md file may have been moved, renamed, or deleted which is causing this broken link.

Thank you for your attention to this matter.

trpc + next

delete key in the UI

Allow a user to delete them

Examples

basics:

• #93
• #94
• #95

more advanced:

• #96
• #97

[KEY-63] [KEY-62] Confirm modal does not submit on enter

_{From SyncLinear.com | KEY-62}

_KEY-63

limited keys for AI generation (doesn't actually have to call openai)

Create sign up and sign pages

Create our login page:

• Support Email (login code)
• Google and Github

Enable custom defaults for key prefix and bytes length

The current key creation form enables users to set a key prefix and bytes length (among others) with the default form values of "key" and "16" respectively. When creating many keys manually, this is annoying to keep changing these values to my custom overrides. It would reduce friction to enable saving a set of defaults either per API or per Workspace to help enforce consistency for those using the dashboard GUI.

Create Post onboarding explainer for API usage

The API is a killer feature lets promote a two way after creation.

The thing we are missing.

• API creation from the API

Create APIs for onboarding flow.

When onboarding.

1. Insert user into DB
2. Creates their tentant adds a DB entry.
3. Create their API key that needs to be associated with the user.

Improve README

Thanks for the amazing project!

Currently the readme, doesn't explain clearly on how to setup and run the repo locally.

It would be easier to contribute to the repo and project with the necessary details 😄

Why are we loading apis in the middleware

https://github.com/chronark/unkey/blob/5944a1765e922815f80b9a112c2ed64168326789/apps/web/middleware.ts#L11

[ui] 2 Minor UI fixes.

Issue: 2 Minor UI fixes

😄 I am willing to fix this issue, Can I? and create the pull request right away? @chronark @perkinsjr

1. Like all other clickable items on the website has cursor of pointer. but this is not the case with WorkspaceSwitcher's buttons.

• 

2. The signout button container is not taking up the whole space.

• 

[KEY-69] Duplicate workspace slug error message

_{From SyncLinear.com | KEY-69}