OIDC: Add configurable username mapping via oidc.username_claim_order
#3003
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.
Add support for deriving Headscale usernames from configurable OIDC claims, addressing IdPs (like Google) that omit the standard
preferred_usernameclaim.Fixes #3002
Summary
This PR adds a configurable way to derive the Headscale username from OIDC claims. It addresses IdPs (like Google) that do not emit
preferred_username, enabling predictable, valid usernames without manual remediation.Changes
oidc.username_claim_order(array) that defines a priority list of claims to try.preferred_username,email_localpart,email,name,sub.[preferred_username, email_localpart, email, name, sub].ValidateUsernamerules.Username()resolves reliably.Example Configuration
Notes
ValidateUsername.preferred_usernameis present.