Document OAuth2 username claim resolution and configuration - #338
Open
3keyroman wants to merge 2 commits into
Open
Document OAuth2 username claim resolution and configuration#3383keyroman wants to merge 2 commits into
3keyroman wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the ILM documentation to clearly describe how OAuth 2.0 user identity is derived from token claims, emphasizing that a single configured claim (usernameClaim, defaulting to username) is authoritative with no fallback behavior. It also adds operational guidance for common IdP configurations (e.g., Microsoft Entra ID) and warns about impacts when changing the configured claim or issuer matching.
Changes:
- Documents deterministic username resolution using
usernameClaim(orusernameby default) with no fallback when missing. - Adds configuration guidance for IdPs that emit
preferred_usernameinstead ofusername. - Adds warnings about changing
usernameClaimon existing providers and clarifies issuer URL uniqueness requirements.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Changes
usernameClaim(defaultusername) is the single source, with no fallback to any other claimpreferred_usernameinstead, such as Microsoft Entra ID