Class OidcUserInfoEndpointConfigurer
java.lang.Object
org.springframework.security.oauth2.server.authorization.config.annotation.web.configurers.OidcUserInfoEndpointConfigurer
Configurer for OpenID Connect 1.0 UserInfo Endpoint.
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationProvider
(org.springframework.security.authentication.AuthenticationProvider authenticationProvider) Adds anAuthenticationProvider
used for authenticating anOidcUserInfoAuthenticationToken
.authenticationProviders
(Consumer<List<org.springframework.security.authentication.AuthenticationProvider>> authenticationProvidersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationProvider
's allowing the ability to add, remove, or customize a specificAuthenticationProvider
.errorResponseHandler
(org.springframework.security.web.authentication.AuthenticationFailureHandler errorResponseHandler) Sets theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
and returning theError Response
.protected final org.springframework.security.config.annotation.ObjectPostProcessor<Object>
protected final <T> T
postProcess
(T object) userInfoMapper
(Function<OidcUserInfoAuthenticationContext, org.springframework.security.oauth2.core.oidc.OidcUserInfo> userInfoMapper) Sets theFunction
used to extract claims fromOidcUserInfoAuthenticationContext
to an instance ofOidcUserInfo
for the UserInfo response.userInfoRequestConverter
(org.springframework.security.web.authentication.AuthenticationConverter userInfoRequestConverter) Adds anAuthenticationConverter
used when attempting to extract an UserInfo Request fromHttpServletRequest
to an instance ofOidcUserInfoAuthenticationToken
used for authenticating the request.userInfoRequestConverters
(Consumer<List<org.springframework.security.web.authentication.AuthenticationConverter>> userInfoRequestConvertersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationConverter
's allowing the ability to add, remove, or customize a specificAuthenticationConverter
.userInfoResponseHandler
(org.springframework.security.web.authentication.AuthenticationSuccessHandler userInfoResponseHandler) Sets theAuthenticationSuccessHandler
used for handling anOidcUserInfoAuthenticationToken
and returning theUserInfo Response
.
-
Method Details
-
userInfoRequestConverter
public OidcUserInfoEndpointConfigurer userInfoRequestConverter(org.springframework.security.web.authentication.AuthenticationConverter userInfoRequestConverter) Adds anAuthenticationConverter
used when attempting to extract an UserInfo Request fromHttpServletRequest
to an instance ofOidcUserInfoAuthenticationToken
used for authenticating the request.- Parameters:
userInfoRequestConverter
- anAuthenticationConverter
used when attempting to extract an UserInfo Request fromHttpServletRequest
- Returns:
- the
OidcUserInfoEndpointConfigurer
for further configuration - Since:
- 0.4.0
-
userInfoRequestConverters
public OidcUserInfoEndpointConfigurer userInfoRequestConverters(Consumer<List<org.springframework.security.web.authentication.AuthenticationConverter>> userInfoRequestConvertersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationConverter
's allowing the ability to add, remove, or customize a specificAuthenticationConverter
.- Parameters:
userInfoRequestConvertersConsumer
- theConsumer
providing access to theList
of default and (optionally) addedAuthenticationConverter
's- Returns:
- the
OidcUserInfoEndpointConfigurer
for further configuration - Since:
- 0.4.0
-
authenticationProvider
public OidcUserInfoEndpointConfigurer authenticationProvider(org.springframework.security.authentication.AuthenticationProvider authenticationProvider) Adds anAuthenticationProvider
used for authenticating anOidcUserInfoAuthenticationToken
.- Parameters:
authenticationProvider
- anAuthenticationProvider
used for authenticating anOidcUserInfoAuthenticationToken
- Returns:
- the
OidcUserInfoEndpointConfigurer
for further configuration - Since:
- 0.4.0
-
authenticationProviders
public OidcUserInfoEndpointConfigurer authenticationProviders(Consumer<List<org.springframework.security.authentication.AuthenticationProvider>> authenticationProvidersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationProvider
's allowing the ability to add, remove, or customize a specificAuthenticationProvider
.- Parameters:
authenticationProvidersConsumer
- theConsumer
providing access to theList
of default and (optionally) addedAuthenticationProvider
's- Returns:
- the
OidcUserInfoEndpointConfigurer
for further configuration - Since:
- 0.4.0
-
userInfoResponseHandler
public OidcUserInfoEndpointConfigurer userInfoResponseHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler userInfoResponseHandler) Sets theAuthenticationSuccessHandler
used for handling anOidcUserInfoAuthenticationToken
and returning theUserInfo Response
.- Parameters:
userInfoResponseHandler
- theAuthenticationSuccessHandler
used for handling anOidcUserInfoAuthenticationToken
- Returns:
- the
OidcUserInfoEndpointConfigurer
for further configuration - Since:
- 0.4.0
-
errorResponseHandler
public OidcUserInfoEndpointConfigurer errorResponseHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler errorResponseHandler) Sets theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
and returning theError Response
.- Parameters:
errorResponseHandler
- theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
- Returns:
- the
OidcUserInfoEndpointConfigurer
for further configuration - Since:
- 0.4.0
-
userInfoMapper
public OidcUserInfoEndpointConfigurer userInfoMapper(Function<OidcUserInfoAuthenticationContext, org.springframework.security.oauth2.core.oidc.OidcUserInfo> userInfoMapper) Sets theFunction
used to extract claims fromOidcUserInfoAuthenticationContext
to an instance ofOidcUserInfo
for the UserInfo response.The
OidcUserInfoAuthenticationContext
gives the mapper access to theOidcUserInfoAuthenticationToken
, as well as, the following context attributes:OidcUserInfoAuthenticationContext.getAccessToken()
containing the bearer token used to make the request.OidcUserInfoAuthenticationContext.getAuthorization()
containing theOidcIdToken
andOAuth2AccessToken
associated with the bearer token used to make the request.
- Parameters:
userInfoMapper
- theFunction
used to extract claims fromOidcUserInfoAuthenticationContext
to an instance ofOidcUserInfo
- Returns:
- the
OidcUserInfoEndpointConfigurer
for further configuration
-
postProcess
protected final <T> T postProcess(T object) -
getObjectPostProcessor
protected final org.springframework.security.config.annotation.ObjectPostProcessor<Object> getObjectPostProcessor()
-