Skip to content

Document Admin role requirement for generating Fern API keys #6934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nerminamiller-postman merged 1 commit into from
Sep 14, 2026
+6 −2
Merged

Document Admin role requirement for generating Fern API keys #6934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion fern/products/dashboard/pages/permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Viewers have read-only access to the Dashboard (settings, analytics) and can dep
| Manage members | Yes | No | No |
| Add or update a custom domain | Yes | No | No |
| Manage password protection | Yes | No | No |
| Manage [API keys](/learn/dashboard/configuration/api-keys) | Yes | No | No |
| Manage [API keys](/learn/dashboard/configuration/api-keys) (Dashboard or `fern token`) | Yes | No | No |
| Set [Ask Fern query log retention](/learn/docs/ai-features/ask-fern/overview#features) | Yes | No | No |
| Delete production docs sites | Yes | No | No |
| View dashboard and analytics | Yes | Yes | Yes |
Expand Down
4 changes: 3 additions & 1 deletion fern/products/docs/pages/ask-fern/api-get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@ The Fern AI API allows you to manage your Ask Fern configuration using Fern's pu

## Authentication

Fern API requests require an API key for authentication. Use the CLI command [`fern token`](/learn/cli-api-reference/cli-reference/general-commands#fern-token) to generate an API key. API keys don't expire.
Fern API requests require an API key for authentication. Use the CLI command [`fern token`](/learn/cli-api-reference/cli-reference/general-commands#fern-token) or the [API keys](/learn/dashboard/configuration/api-keys) page in the Dashboard to generate an API key. API keys don't expire.

Only organization [Admins](/learn/dashboard/configuration/permissions#admin) can generate API keys. If you have the Editor or Viewer role, ask an Admin to generate a key for you. Once you have a key, calling the API doesn't require any additional role.
2 changes: 2 additions & 0 deletions fern/snippets/fern-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Use `fern token` to generate an API key for authenticating the Fern CLI in CI/CD environments. The API key is specific to your organization defined in [`fern.config.json`](/learn/sdks/overview/project-structure#fernconfigjson) and doesn't expire. You can also create and manage API keys from the [API keys](/learn/dashboard/configuration/api-keys) page in the Dashboard.

Generating an API key requires the [Admin](/learn/dashboard/configuration/permissions#admin) role in the organization. Members with the Editor or Viewer role receive a `Failed to create token because you do not have the required permissions` error and need an Admin to generate the key for them.

<CodeBlock title="terminal">
```bash
fern token
Expand Down
Loading