Document the Oauth2AuthorizationServer client settings #18614
+26
−0
Conversation
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
Added documentation to describe the possible client configuration options when setting up an Oauth2 Authorization Server. Signed-off-by: Elayne Bloom <[email protected]>
spring-projects-issues
added
the
status: waiting-for-triage
bloomsei
commented
Jan 28, 2026
Comment on lines
+102
to
+108
| ClientSettings.builder() | ||
| .requireProofKey() <1> | ||
| .requireAuthorizationConsent() <2> | ||
| .jwkSetUrl() <3> | ||
| .tokenEndpointAuthenticationSigningAlgorithm() <4> | ||
| .x509CertificateSubjectDN() <5> | ||
| .build(); |
Author
There was a problem hiding this comment.
I know this does not match the rest of this documentation page. To match it, I would have had to describe ClientSettings and not its builder. However, that would then describe methods like isRequireProofKey, which is not very helpful for the users.
Personally, as I user I would more expect configuration options to be described as what I would use in my application.yml/.properties rather than configuration classes themselves, but that would be even further away from the rest of the configuration.
I am happy to adopt another way of documenting this, if you tell me what to prefer in this case.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Added documentation to describe the possible client configuration options using
ClientSettingswhen setting up an Oauth2 Authorization Server.This change was discussed in: gh-18304