diff --git a/fern/products/docs/pages/authentication/overview.mdx b/fern/products/docs/pages/authentication/overview.mdx index b1a41ca1d3..57e90cf661 100644 --- a/fern/products/docs/pages/authentication/overview.mdx +++ b/fern/products/docs/pages/authentication/overview.mdx @@ -1,9 +1,11 @@ --- -title: Overview of authentication options -description: Gate your docs so readers only see the content relevant to them. +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: @@ -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 (Okta, Google Workspace, etc.) for internal docs or wikis. Supports [role-based access control](/learn/docs/authentication/features/rbac) when your identity provider includes roles on the token. +- **[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 + + + + 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. + + + 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. + + + 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. + + + Password protection is available on paid plans. SSO, JWT, and OAuth are Enterprise features. See [pricing](https://buildwithfern.com/pricing) for details. + +