docs: document RBAC restriction badge on page headers#5980
Open
fern-api[bot] wants to merge 6 commits into
Open
docs: document RBAC restriction badge on page headers#5980fern-api[bot] wants to merge 6 commits into
fern-api[bot] wants to merge 6 commits into
Conversation
Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Author
|
Requested by: devin.logan |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| - **Authenticated-only pages** (no `viewers` specified): "Only visible to authenticated users." | ||
| - **Role-restricted pages** (`viewers` specified): lists the role names that can view the page. | ||
|
|
||
| The badge appears automatically on all restricted page types, including API reference endpoints. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1782431136-rbac-restriction-badge-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: bot_apk <apk@cognition.ai>
Co-Authored-By: bot_apk <apk@cognition.ai>
|
|
||
| Use it for partner docs, beta features, tiered pricing content, and internal resources. You can combine it with [API key injection](/learn/docs/authentication/features/api-key-injection) when using JWT or OAuth authentication. When RBAC is configured, [Ask Fern](/learn/docs/ai-features/ask-fern/overview) automatically respects these permissions. By default, restricted pages are completely hidden from unauthorized users — if you'd like them to be visible but locked instead, let Fern know during setup. | ||
|
|
||
| In locked mode, restricted pages display a lock icon next to the page title, and hovering over it shows which roles have access. The badge appears automatically on all restricted page types, including API reference endpoints. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
devalog
approved these changes
Jun 27, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a "Restriction badge" section to the RBAC docs page documenting the new lock-icon badge that appears next to page titles on restricted pages (shipped in fern-platform#12065).
The badge shows automatically on all restricted page types (markdown pages and API reference endpoints):
viewers: tooltip says "Only visible to authenticated users."viewers: tooltip lists the role namesIncludes a screenshot of the badge. No configuration required — the badge renders whenever RBAC or authentication is active.
Requested by: Fern Support