Repository navigation
Improve authentication overview page for discoverability #7721
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,9 +1,11 @@ | ||||||
| --- | ||||||
| title: Authentication overview | ||||||
| description: "Gate your docs with SSO, password protection, JWT, or OAuth. Works with Okta, Google Workspace, Azure AD (Entra ID), Auth0, and any SAML 2.0 or OIDC provider." | ||||||
| --- | ||||||
|
|
||||||
|
|
||||||
| Fern lets you control who can read your documentation. You can require a shared password, integrate with your company's SSO provider (Okta, Google Workspace, Azure AD / Entra ID, Auth0, OneLogin, and any SAML 2.0 or OIDC provider), or connect your own login system via JWT or OAuth. All methods support [role-based access control](/learn/docs/authentication/features/rbac) to show different content to different audiences. | ||||||
|
|
||||||
| Fern offers four ways to authenticate users on your documentation site: | ||||||
|
|
||||||
| <CardGroup cols={2}> | ||||||
|
|
@@ -24,7 +26,7 @@ Fern offers four ways to authenticate users on your documentation site: | |||||
| ## Which option should I use? | ||||||
|
|
||||||
| - **[Password protection](/learn/docs/authentication/setup/password-protection)** — You need quick gating with a shared password (no per-user accounts). Supports multiple passwords mapped to roles for [role-based access control](/learn/docs/authentication/features/rbac). | ||||||
| - **[SSO](/learn/docs/authentication/setup/sso)** — Your team should log in with corporate credentials for internal docs or wikis (Okta, Google Workspace, Azure AD / Entra ID, Auth0, OneLogin, and any SAML 2.0 or OIDC provider). Supports [role-based access control](/learn/docs/authentication/features/rbac) when your identity provider includes roles on the token. | ||||||
| - **[JWT](/learn/docs/authentication/setup/jwt)** — You want to integrate with your existing login system and control the entire auth flow yourself. Supports [role-based access control](/learn/docs/authentication/features/rbac) and [API key injection](/learn/docs/authentication/features/api-key-injection). | ||||||
| - **[OAuth](/learn/docs/authentication/setup/oauth)** — You want to integrate with your existing login system but have Fern manage the auth flow via your OAuth provider. Supports [role-based access control](/learn/docs/authentication/features/rbac) and [API key injection](/learn/docs/authentication/features/api-key-injection). | ||||||
|
|
||||||
|
|
@@ -35,3 +37,20 @@ JWT and OAuth share the same capabilities — the difference is who manages the | |||||
| JWT, OAuth, and SSO are all powered by a [browser cookie](/learn/docs/security/overview) called `fern_token` that tells Fern who the user is and what they can access. The token can carry user roles for [RBAC](/learn/docs/authentication/features/rbac), API keys for the [API Explorer](/learn/docs/api-references/api-explorer), or simply verify that a user is logged in. | ||||||
|
|
||||||
| [Password protection](/learn/docs/authentication/setup/password-protection) works differently — it uses a shared password rather than per-user tokens. | ||||||
|
|
||||||
| ## Common questions | ||||||
|
|
||||||
| <AccordionGroup> | ||||||
| <Accordion title="Does Fern support Entra ID (Azure AD) SSO?"> | ||||||
| Yes. Fern's SSO works with any SAML 2.0 or OIDC provider, including Microsoft Entra ID (formerly Azure AD). [Contact Fern](https://buildwithfern.com/book-demo) to set it up. | ||||||
| </Accordion> | ||||||
| <Accordion title="Can I integrate SSO with third-party service users (not just internal employees)?"> | ||||||
| Yes. SSO is not limited to internal teams. You can gate docs for any audience — partners, customers, or external developers — as long as they authenticate through your identity provider. Combine SSO with [RBAC](/learn/docs/authentication/features/rbac) to show different content to different user groups. | ||||||
| </Accordion> | ||||||
| <Accordion title="Which authentication method supports API key injection?"> | ||||||
| JWT and OAuth both support [API key injection](/learn/docs/authentication/features/api-key-injection), which pre-fills a user's API key in the API Explorer after they log in. SSO and password protection do not support API key injection. | ||||||
|
Contributor
There was a problem hiding this comment. 🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Suggested change
|
||||||
| </Accordion> | ||||||
| <Accordion title="Is authentication available on the free plan?"> | ||||||
| Password protection is available on paid plans. SSO, JWT, and OAuth are Enterprise features. See [pricing](https://buildwithfern.com/pricing) for details. | ||||||
| </Accordion> | ||||||
| </AccordionGroup> | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'isn't' instead of 'is not'.