Skip to content

Update from code changes: document OAuth token claims for groups#6684

Merged
ethanpalm merged 3 commits into
mainfrom
mintlify/b8d368df
Jul 21, 2026
Merged

Update from code changes: document OAuth token claims for groups#6684
ethanpalm merged 3 commits into
mainfrom
mintlify/b8d368df

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

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 source and groupsClaim), 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

  • Added Token claims to the OAuth field list with a link to the new section.
  • Added a new Derive groups from token claims section covering source selection (id_token vs access_token), supported claim path formats, value normalization, and fail-closed behavior.
  • Updated OAuth 2.0 prerequisites and the Info API URL description to reflect the new alternative.

Note

Low Risk
Documentation-only changes to authentication setup pages; no runtime or security logic in this PR.

Overview
Documents the new optional Token claims OAuth setting so customers can derive user groups from id_token or access_token JWTs (source, groupsClaim) instead of relying only on Info API URL.

Adds a Derive groups from token claims section (English plus es, fr, zh locales) covering claim path formats, Auth0/Keycloak examples, and fail-closed sign-in when the configured token is missing. OAuth prerequisites and the Info API URL blurb are updated to present token claims and the user-info endpoint as two ways to supply groups for group-based access control.

Reviewed by Cursor Bugbot for commit 363b7e0. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 21, 2026, 4:36 AM

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 21, 2026, 4:36 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread deploy/authentication-setup.mdx Outdated
@ethanpalm
ethanpalm merged commit e3257c2 into main Jul 21, 2026
4 checks passed
@ethanpalm
ethanpalm deleted the mintlify/b8d368df branch July 21, 2026 17:30
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