Skip to content

Document RegisteredClient.ClientSettings#18614

Closed
bloomsei wants to merge 1 commit intospring-projects:mainfrom
bloomsei:docs-oauth2-server-client-settings
Closed

Document RegisteredClient.ClientSettings#18614
bloomsei wants to merge 1 commit intospring-projects:mainfrom
bloomsei:docs-oauth2-server-client-settings

Conversation

@bloomsei
Copy link
Contributor

Added documentation to describe the possible client configuration options using ClientSettings when setting up an Oauth2 Authorization Server.

This change was discussed in: gh-18304

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 28, 2026
Comment on lines +102 to +108
ClientSettings.builder()
.requireProofKey() <1>
.requireAuthorizationConsent() <2>
.jwkSetUrl() <3>
.tokenEndpointAuthenticationSigningAlgorithm() <4>
.x509CertificateSubjectDN() <5>
.build();
Copy link
Contributor Author

@bloomsei bloomsei Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bloomsei Can you change the format to match the code sample in Configuring Authorization Server Settings

Copy link
Contributor Author

@bloomsei bloomsei Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I followed the code sample that you specified and used the example values from your tests. The other option would be to use the variables like Configuring Client Authentication, but I find this provides useful additional information. I hope this fits, otherwise happy to go into another direction.

Thank you for reviewing!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies @bloomsei but I lead you down the wrong path when I asked you to follow the Authorization Server settings code sample. To be consistent with the rest of the page, I think describing the accessors makes the most sense, given that there are no typed members since it's backed by a Map.

I went ahead and made the change in a polish commit. This is now merged. Thanks for the updates!

@jgrandja jgrandja self-assigned this Feb 2, 2026
@jgrandja jgrandja added type: enhancement A general enhancement in: oauth2 An issue in OAuth2 modules (oauth2-core, oauth2-client, oauth2-resource-server, oauth2-jose) and removed status: waiting-for-triage An issue we've not yet triaged labels Feb 2, 2026
@jgrandja jgrandja added this to the 7.1.0-M2 milestone Feb 2, 2026
@jgrandja jgrandja changed the title Document the Oauth2AuthorizationServer client settings Document the RegisteredClient.ClientSettings Feb 2, 2026
@jgrandja jgrandja changed the title Document the RegisteredClient.ClientSettings Document RegisteredClient.ClientSettings Feb 2, 2026
Added documentation to describe the possible client configuration options when setting up an Oauth2 Authorization Server.

Signed-off-by: Elayne Bloom <5840349+bloomsei@users.noreply.github.com>
@bloomsei bloomsei force-pushed the docs-oauth2-server-client-settings branch from e880a11 to d05ff9c Compare February 4, 2026 16:33
@bloomsei bloomsei requested a review from jgrandja February 4, 2026 16:34
@jgrandja jgrandja closed this in a2d4075 Feb 5, 2026
jgrandja added a commit that referenced this pull request Feb 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in: oauth2 An issue in OAuth2 modules (oauth2-core, oauth2-client, oauth2-resource-server, oauth2-jose) type: enhancement A general enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants