From 564fb0e5fd098e91de79eaa3c3130dd8edcff740 Mon Sep 17 00:00:00 2001 From: "chris.mcdonnell" Date: Fri, 11 Sep 2026 19:59:03 +0000 Subject: [PATCH] docs: document Admin role requirement for generating API keys Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- fern/products/dashboard/pages/permissions.mdx | 2 +- fern/products/docs/pages/ask-fern/api-get-started.mdx | 4 +++- fern/snippets/fern-token.mdx | 2 ++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/fern/products/dashboard/pages/permissions.mdx b/fern/products/dashboard/pages/permissions.mdx index e866fd8dcf..539ccb7bca 100644 --- a/fern/products/dashboard/pages/permissions.mdx +++ b/fern/products/dashboard/pages/permissions.mdx @@ -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 | diff --git a/fern/products/docs/pages/ask-fern/api-get-started.mdx b/fern/products/docs/pages/ask-fern/api-get-started.mdx index cfecf6fd5b..193eb213dc 100644 --- a/fern/products/docs/pages/ask-fern/api-get-started.mdx +++ b/fern/products/docs/pages/ask-fern/api-get-started.mdx @@ -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. diff --git a/fern/snippets/fern-token.mdx b/fern/snippets/fern-token.mdx index 8d9a72f5f4..4b8da4d2c4 100644 --- a/fern/snippets/fern-token.mdx +++ b/fern/snippets/fern-token.mdx @@ -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. + ```bash fern token