fix: correct step numbering, clarify role mapping rules, and fix Okta/Entra doc copy errors - #3860
Conversation
📝 WalkthroughWalkthroughThis PR updates enterprise SSO setup documentation for Microsoft Entra and Okta. The Entra guide clarifies claim mapping configuration options and adds UI verification steps; it corrects attribute mapping references and simplifies evaluation rule descriptions. The Okta guide adjusts step numbering, refreshes screenshot alt text, and expands role assignment rule behavior when multiple mappings match. ChangesEntra Setup Guide Updates
Okta Setup Guide Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This stack of pull requests is managed by Graphite. Learn more about stacking. |
6f32cfc to
c77f715
Compare
c1d74b2 to
9f27dc8
Compare
c77f715 to
d3ceaf6
Compare
Confidence Score: 4/5Safe to merge — all changes are documentation-only with no impact on runtime behaviour. The fixes are accurate and improve clarity, but two small issues remain: the Entra guide retains an orphaned numbered step that the Okta guide correctly had removed, and both guides now contain a self-contradictory evaluation-rule bullet ('first match wins' alongside 'highest privilege for multiple matches') that could lead users to misconfigure their role mappings. docs/enterprise/setting-up-entra.mdx — orphaned step and contradictory evaluation rule; docs/enterprise/setting-up-okta.mdx — same contradictory evaluation rule. Important Files Changed
Reviews (1): Last reviewed commit: "docs: entra and okta docs typo fixes" | Re-trigger Greptile |
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/enterprise/setting-up-okta.mdx (1)
279-385:⚠️ Potential issue | 🟠 Major | 🏗️ Heavy liftAdd required Web UI / API / config.json tabs to the Okta configuration section.
This MDX setup section is still single-path (“Using the Bifrost UI”) and does not include the required Web UI / API / config.json tab structure, so it currently misses the docs standard for provider configuration pages.
As per coding guidelines: "
docs/**/*.mdx: Mintlify MDX documentation must have Web UI / API / config.json tabs; validate config.json examples against transports/config.schema.json".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/enterprise/setting-up-okta.mdx` around lines 279 - 385, The Okta provider doc under "Step 9: Configure Bifrost" is missing the required tabbed structure (Web UI / API / config.json); update this MDX to split the configuration section into three tabs showing: 1) Web UI (existing step-by-step UI instructions and screenshots), 2) API (example API payloads and endpoints for creating/updating a provider), and 3) config.json (a JSON config example containing keys like issuerUrl, authServerType, clientId, clientSecret, audience, attributeRoleMappings, attributeTeamMappings, attributeBusinessUnitMappings); ensure the config.json example validates against transports/config.schema.json and mention authServerType values (`org` | `custom`) and audience behavior for each.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/enterprise/setting-up-okta.mdx`:
- Around line 279-385: The Okta provider doc under "Step 9: Configure Bifrost"
is missing the required tabbed structure (Web UI / API / config.json); update
this MDX to split the configuration section into three tabs showing: 1) Web UI
(existing step-by-step UI instructions and screenshots), 2) API (example API
payloads and endpoints for creating/updating a provider), and 3) config.json (a
JSON config example containing keys like issuerUrl, authServerType, clientId,
clientSecret, audience, attributeRoleMappings, attributeTeamMappings,
attributeBusinessUnitMappings); ensure the config.json example validates against
transports/config.schema.json and mention authServerType values (`org` |
`custom`) and audience behavior for each.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 29a39b24-609f-4015-8ba6-f2a1020dc2e6
📒 Files selected for processing (2)
docs/enterprise/setting-up-entra.mdxdocs/enterprise/setting-up-okta.mdx
Merge activity
|
…/Entra doc copy errors (#3860) ## Summary Fixes several inaccuracies and inconsistencies in the Entra and Okta SSO setup documentation, including incorrect step numbering, a copy-paste error referencing Okta in the Entra guide, and outdated role mapping behavior descriptions. ## Changes - Clarified the Step 6 note in the Entra guide to inform users that configuring claims via the App Manifest JSON (Step 9) overrides UI-based token configuration - Fixed step numbering in the Entra Bifrost configuration section (steps 5–7 renumbered to 4–6) - Corrected a copy-paste error where "Okta claims" was written instead of "Entra claims" in the Entra attribute mappings section - Consolidated the role mapping evaluation rules note into the bullet list for both Entra and Okta guides, removing the redundant `<Note>` block that incorrectly stated the first user to sign in receives Admin - Updated the manifest troubleshooting reference from "Step 8" to "Step 9" in the Entra guide - Fixed step numbering in the Okta user assignment section (step 4 renumbered to 3) - Improved the alt text for the Okta configuration form image to be more descriptive - Removed a misplaced "Click Save Configuration" step from the Okta attribute mappings section ## Type of change - [ ] Bug fix - [ ] Feature - [ ] Refactor - [x] Documentation - [ ] Chore/CI ## Affected areas - [ ] Core (Go) - [ ] Transports (HTTP) - [ ] Providers/Integrations - [ ] Plugins - [ ] UI (React) - [x] Docs ## How to test Review the rendered documentation pages for the Entra and Okta setup guides to confirm step numbering is correct, the role mapping evaluation rules are accurate, and no references to the wrong identity provider remain. ## Breaking changes - [x] No ## Related issues ## Security considerations None. ## Checklist - [ ] I read `docs/contributing/README.md` and followed the guidelines - [ ] I added/updated tests where appropriate - [x] I updated documentation where needed - [ ] I verified builds succeed (Go and UI) - [ ] I verified the CI pipeline passes locally if applicable <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified claim mapping configuration options for Microsoft Entra setup (UI vs. App Manifest, with manifest as source of truth) * Added explicit verification and confirmation steps before enabling provider configuration * Corrected Attribute Mappings section to reference Entra claims * Simplified role assignment behavior: unmatched users are denied login * Enhanced Okta role mapping documentation to specify highest-privilege role assignment when multiple rules match <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/maximhq/bifrost/pull/3860?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai -->

Summary
Fixes several inaccuracies and inconsistencies in the Entra and Okta SSO setup documentation, including incorrect step numbering, a copy-paste error referencing Okta in the Entra guide, and outdated role mapping behavior descriptions.
Changes
<Note>block that incorrectly stated the first user to sign in receives AdminType of change
Affected areas
How to test
Review the rendered documentation pages for the Entra and Okta setup guides to confirm step numbering is correct, the role mapping evaluation rules are accurate, and no references to the wrong identity provider remain.
Breaking changes
Related issues
Security considerations
None.
Checklist
docs/contributing/README.mdand followed the guidelinesSummary by CodeRabbit