Update from code changes: document OAuth token claims for groups#6684
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document OAuth token claims for groups#6684mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
Documents a new OAuth 2.0 configuration option that lets customers derive user groups directly from the JWT returned by their token endpoint (via
sourceandgroupsClaim), instead of hosting a separate user info endpoint. Adds a new "Derive groups from token claims" section on the authentication setup page with examples for top-level, Auth0-namespaced, and Keycloak-nested claims, and notes the fail-closed behavior when the configured token is missing. Also updates the OAuth 2.0 prerequisites and the Info API URL field description so customers can choose between the two group sources.Triggered by https://github.com/mintlify/server/pull/6815.
Changes
id_tokenvsaccess_token), supported claim path formats, value normalization, and fail-closed behavior.Note
Low Risk
Documentation-only changes to authentication setup guides; no application code or runtime behavior in this repo.
Overview
Adds documentation for Token claims, an optional OAuth dashboard field that reads user groups from the JWT in the token response (
source+groupsClaim) instead of calling Info API URL.OAuth prerequisites and the Info API URL description are updated so group-based access can come from token claims or a user-info endpoint. A new Derive groups from token claims section explains behavior (claim paths, array vs string values, skipping the info API for groups) and fail-closed sign-in when the configured token is missing. JSON examples cover
access_token/groupsand Keycloakrealm_access.roles. The same content is mirrored ines,fr, andzhauthentication-setup.mdxfiles.Reviewed by Cursor Bugbot for commit 959a131. Bugbot is set up for automated code reviews on this repo. Configure here.