Skip to content

docs: document RBAC support for SSO authentication#6318

Merged
thesandlord merged 3 commits into
mainfrom
devin/1784559900-sso-rbac-docs
Jul 20, 2026
Merged

docs: document RBAC support for SSO authentication#6318
thesandlord merged 3 commits into
mainfrom
devin/1784559900-sso-rbac-docs

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Documents the new capability from fern-platform#13195: the native WorkOS SSO flow now carries the user's roles into the fern_token, so SSO can be used with RBAC (viewers: / <If roles={...}>). Previously RBAC was limited to JWT and OAuth.

Changes across the authentication docs:

  • sso.mdx — corrected the callout that claimed SSO "doesn't support role management" (now: SSO supports RBAC but not API key injection), and added a Role-based access control section explaining that Fern reads roles from the identity provider's token, and the customer must populate roles (org roles or SSO/directory group mapping).
  • rbac.mdx — added SSO alongside password/JWT/OAuth in the supported-methods sentence, the setup step, and the Enterprise-plan callout.
  • overview.mdx — the SSO bullet in "Which option should I use?" now notes RBAC support.
  • changelog/2026-07-20.mdx — new security-tagged entry.

Framed for docs users (SSO setup is Fern-managed), not the WorkOS roles_claim config internals.

Link to Devin session: https://app.devin.ai/sessions/56cdeaf6d474438895bd7e063d224a9e

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration
devin-ai-integration Bot requested a review from devalog as a code owner July 20, 2026 15:05
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@@ -0,0 +1,9 @@
## SSO now supports role-based access control

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'SSO now supports role-based access control' should use sentence-style capitalization.

@github-actions

Copy link
Copy Markdown
Contributor


SSO can gate content by role. Fern reads each user's roles from the token your identity provider issues, then applies the [`roles`](/learn/docs/authentication/features/rbac#setup) and [`viewers`](/learn/docs/authentication/features/rbac#in-navigation) rules in your `docs.yml`.

The identity provider must include the user's roles on the token. Enable organization roles in your provider, then either assign roles to users directly or map your SSO/directory groups to those roles. Fern uses the organization role by default; to read roles from a custom token claim instead, tell Fern which claim to parse.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you provide details on how to do this

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a concrete <Steps> walkthrough (38b9914): enable Organization Roles in WorkOS → assign roles directly or via SSO/directory-group mapping (SCIM) → declare the same slugs in docs.yml. Also noted the default org-role behavior and the custom-claim option. Let me know if you'd like the WorkOS dashboard click-paths spelled out too.

thesandlord and others added 2 commits July 20, 2026 15:10
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@thesandlord
thesandlord merged commit 0dad211 into main Jul 20, 2026
4 checks passed
@thesandlord
thesandlord deleted the devin/1784559900-sso-rbac-docs branch July 20, 2026 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants