Skip to content

Commit d974a74

Browse files
committed
Merge pull request #10615 from vpavic:improve-oauth-docs
* pr/10615: Use properties in Security OAuth2 Client doc config example Fix Security OAuth2 Client documentation
2 parents d307eba + 1223367 commit d974a74

File tree

1 file changed

+25
-32
lines changed

1 file changed

+25
-32
lines changed

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2836,46 +2836,39 @@ explicitly configure the paths that you do want to override.
28362836
[[boot-features-security-oauth2]]
28372837
=== OAuth2
28382838

2839-
=== Client
2839+
==== Client
28402840
If you have `spring-security-oauth2-client` on your classpath you can take advantage of
28412841
some auto-configuration to make it easy to set up an OAuth2 Client. This configuration
28422842
makes use of the properties under `OAuth2ClientProperties`.
28432843

28442844
You can register multiple OAuth2 clients and providers under the
28452845
`spring.security.oauth2.client` prefix. For example:
28462846

2847-
[source,yaml,indent=0]
2847+
[source,properties,indent=0]
28482848
----
2849-
spring:
2850-
security:
2851-
oauth2:
2852-
client:
2853-
registration:
2854-
my-client-1:
2855-
client-id: abcd
2856-
client-secret: password
2857-
client-name: Client for user scope
2858-
provider: my-oauth-provider
2859-
scope: user
2860-
redirect-uri: http://my-redirect-uri.com
2861-
authentication-method: basic
2862-
authorization-grant-type: authorization_code
2863-
my-client2:
2864-
client-id: abcd
2865-
client-secret: password
2866-
client-name: Client for email scope
2867-
provider: my-oauth-provider
2868-
scope: email
2869-
redirect-uri: http://my-redirect-uri.com
2870-
authentication-method: basic
2871-
authorization-grant-type: authorization_code
2872-
provider:
2873-
my-oauth-provider:
2874-
authorization-uri: http://my-auth-server/oauth/authorize
2875-
token-uri: http://my-auth-server/oauth/token
2876-
user-info-uri: http://my-auth-server/userinfo
2877-
jwk-set-uri: http://my-auth-server/token_keys
2878-
user-name-attribute: name
2849+
spring.security.oauth2.client.registration.my-client-1.client-id:=abcd
2850+
spring.security.oauth2.client.registration.my-client-1.client-secret=password
2851+
spring.security.oauth2.client.registration.my-client-1.client-name=Client for user scope
2852+
spring.security.oauth2.client.registration.my-client-1.provider=my-oauth-provider
2853+
spring.security.oauth2.client.registration.my-client-1.scope=user
2854+
spring.security.oauth2.client.registration.my-client-1.redirect-uri=http://my-redirect-uri.com
2855+
spring.security.oauth2.client.registration.my-client-1.client-authentication-method=basic
2856+
spring.security.oauth2.client.registration.my-client-1.authorization-grant-type=authorization_code
2857+
2858+
spring.security.oauth2.client.registration.my-client-2.client-id=abcd
2859+
spring.security.oauth2.client.registration.my-client-2.client-secret=password
2860+
spring.security.oauth2.client.registration.my-client-2.client-name=Client for email scope
2861+
spring.security.oauth2.client.registration.my-client-2.provider=my-oauth-provider
2862+
spring.security.oauth2.client.registration.my-client-2.scope=email
2863+
spring.security.oauth2.client.registration.my-client-2.redirect-uri=http://my-redirect-uri.com
2864+
spring.security.oauth2.client.registration.my-client-2.client-authentication-method=basic
2865+
spring.security.oauth2.client.registration.my-client-2.authorization-grant-type=authorization_code
2866+
2867+
spring.security.oauth2.client.provider.my-oauth-provider.authorization-uri=http://my-auth-server/oauth/authorize
2868+
spring.security.oauth2.client.provider.my-oauth-provider.token-uri=http://my-auth-server/oauth/token
2869+
spring.security.oauth2.client.provider.my-oauth-provider.user-info-uri=http://my-auth-server/userinfo
2870+
spring.security.oauth2.client.provider.my-oauth-provider.jwk-set-uri=http://my-auth-server/token_keys
2871+
spring.security.oauth2.client.provider.my-oauth-provider.user-name-attribute=name
28792872
----
28802873

28812874
NOTE: For common OAuth2 and OpenID providers such as Google, Github, Facebook and Okta,

0 commit comments

Comments
 (0)