root
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Polish ref doc for oauth2-client

This commit is contained in:
Joe Grandja 2019-09-27 10:46:19 -04:00
parent 5a67971375
commit 9944037cc7
1 changed files with 2 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-client.adoc
View File

@ -303,10 +303,6 @@ public OAuth2AuthorizedClientManager authorizedClientManager(
} }
---- ----
[NOTE]
Spring Boot 2.x auto-configuration registers an `OAuth2AuthorizedClientManager` `@Bean` in the `ApplicationContext`.
However, the application may choose to override and register a custom `OAuth2AuthorizedClientManager` `@Bean`.
The `DefaultOAuth2AuthorizedClientManager` is also associated with a `contextAttributesMapper` of type `Function<OAuth2AuthorizeRequest, Map<String, Object>>`, which is responsible for mapping attribute(s) from the `OAuth2AuthorizeRequest` to a `Map` of attributes to be associated to the `OAuth2AuthorizationContext`. The `DefaultOAuth2AuthorizedClientManager` is also associated with a `contextAttributesMapper` of type `Function<OAuth2AuthorizeRequest, Map<String, Object>>`, which is responsible for mapping attribute(s) from the `OAuth2AuthorizeRequest` to a `Map` of attributes to be associated to the `OAuth2AuthorizationContext`.
This can be useful when you need to supply an `OAuth2AuthorizedClientProvider` with required (supported) attribute(s), eg. the `PasswordOAuth2AuthorizedClientProvider` requires the resource owner's `username` and `password` to be available in `OAuth2AuthorizationContext.getAttributes()`. This can be useful when you need to supply an `OAuth2AuthorizedClientProvider` with required (supported) attribute(s), eg. the `PasswordOAuth2AuthorizedClientProvider` requires the resource owner's `username` and `password` to be available in `OAuth2AuthorizationContext.getAttributes()`.
@ -444,12 +440,12 @@ spring:
registration: registration:
okta: okta:
... ...
redirect-uri: "{baseScheme}{baseHost}{basePort}{basePath}/authorized/{registrationId}" redirect-uri: "{baseScheme}://{baseHost}{basePort}{basePath}/authorized/{registrationId}"
... ...
---- ----
[NOTE] [NOTE]
`{baseUrl}` resolves to `{baseScheme}{baseHost}{basePort}{basePath}` `{baseUrl}` resolves to `{baseScheme}://{baseHost}{basePort}{basePath}`
Configuring the `redirect-uri` with `URI` template variables is especially useful when the OAuth 2.0 Client is running behind a <<appendix-proxy-server, Proxy Server>>. Configuring the `redirect-uri` with `URI` template variables is especially useful when the OAuth 2.0 Client is running behind a <<appendix-proxy-server, Proxy Server>>.
This ensures that the `X-Forwarded-*` headers are used when expanding the `redirect-uri`. This ensures that the `X-Forwarded-*` headers are used when expanding the `redirect-uri`.
@ -871,9 +867,6 @@ public OAuth2AuthorizedClientManager authorizedClientManager(
} }
---- ----
[NOTE]
Spring Boot 2.x auto-configuration registers an `OAuth2AuthorizedClientManager` `@Bean` in the `ApplicationContext`.
You may obtain the `OAuth2AccessToken` as follows: You may obtain the `OAuth2AccessToken` as follows:
[source,java] [source,java]
@ -1143,9 +1136,6 @@ WebClient webClient(OAuth2AuthorizedClientManager authorizedClientManager) {
} }
---- ----
[NOTE]
Spring Boot 2.x auto-configuration registers an `OAuth2AuthorizedClientManager` `@Bean` in the `ApplicationContext`.
==== Providing the Authorized Client ==== Providing the Authorized Client