docs: add client_credentials grant enhancement doc and config example - #4984
Open
bisbeb wants to merge 1 commit into
Open
docs: add client_credentials grant enhancement doc and config example#4984bisbeb wants to merge 1 commit into
bisbeb wants to merge 1 commit into
Conversation
Adds a Dex Enhancement Proposal for the client_credentials grant (RFC 6749 Section 4.4) implemented in dexidp#4583, and documents the clientCredentials grantTypes entry in config.yaml.dist. Closes dexidp#3660 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Björn Bärtschi <linuxsatellite@gmail.com>
bisbeb
force-pushed
the
docs/client-credentials-3660
branch
from
August 26, 2026 19:13
20248ed to
f2a8287
Compare
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.
What this PR does
Adds documentation for the
client_credentialsgrant type implemented in #4583:docs/enhancements/client-credentials-2026-03-03-3660.md: Dex Enhancement Proposal covering motivation, configuration, token claims, an ArgoCD M2M example, and security considerations.config.yaml.dist: Documents theoauth2.grantTypesentry needed to enable the grant, including the full default list withclient_credentialsas an opt-in addition.Why
PR #4583 merged the implementation in March 2026 but no enhancement doc exists yet, and
config.yaml.disthas no example showing how to activate the grant. Operators enabling this feature have no reference beyond reading the source.The enhancement doc follows the same structure as
docs/enhancements/token-exchange-2023-02-03-#2812.md.Verification
All claims in the doc were verified against the current source:
oauth2.grantTypesconfirmed incmd/dex/serve.goandserver/config.goserver/grants/clientcredentials.gosub,aud,name,groups) confirmed inserver/grants/clientcredentials.goandserver/tokens/issuer.goserver/grants/clientcredentials.goCloses #3660