Skip to content

Commit

Permalink
Merge pull request #2738 from neondatabase/project-key-edit
Browse files Browse the repository at this point in the history
Clarify project-scoped key creator
  • Loading branch information
bgrenon authored Jan 7, 2025
2 parents 0aba0ef + acbf056 commit fd93295
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions content/docs/manage/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Neon supports three types of API keys:
| ---------------------- | --------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| Personal API Key | Any user | User's personal projects and any organization projects where they are a member | Valid until revoked; org project access ends if user leaves organization |
| Organization API Key | Organization administrators | All projects within the organization | Valid until revoked |
| Project-scoped API Key | Organization members | Single specified project | Valid until revoked or project leaves organization |
| Project-scoped API Key | Any organization member | Single specified project | Valid until revoked or project leaves organization |

While there is no strict limit on the number of API keys you can create, we recommend keeping it under 10,000 per Neon account.

Expand Down Expand Up @@ -116,11 +116,11 @@ curl --request POST \

Project-scoped API keys have [member-level access](/docs/manage/organizations#user-roles-and-permissions), meaning they **cannot** delete the project they are associated with. These keys:

- Can only access and manage their specified project
- Can only access and manage the specified project
- Cannot perform organization-related actions or create new projects
- Will stop working if the project is transferred out of the organization

Any project member can create an API key for their project using the following command:
Any organization member can create an API key for any organization-owned project using the following command:

```bash shouldWrap
curl --request POST \
Expand Down
2 changes: 1 addition & 1 deletion content/docs/manage/orgs-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ To find your organization's `org_id`, navigate to your Organization's **Settings
There are two types of organization API keys:

- **Organization API keys** — Provide admin-level access to all organization resources, including projects, members, and settings. Only organization admins can create these keys.
- **Project-scoped organization API keys** — Provide limited, member-level access to specific projects within the organization. Any member of a project can create a key for that project.
- **Project-scoped organization API keys** — Provide limited, member-level access to specific projects within the organization. Any organization member can create a key for any organization-owned project.

The key token is only displayed once at creation time. Copy it immediately and store it securely. If lost, you’ll need to revoke the key and create a new one. For detailed instructions, see [Manage API Keys](/docs/manage/api-keys#create-an-organization-api-key).

Expand Down

0 comments on commit fd93295

Please sign in to comment.