Class OidcUserRequest
- java.lang.Object
-
- org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest
-
- org.springframework.security.oauth2.client.oidc.userinfo.OidcUserRequest
-
public class OidcUserRequest extends OAuth2UserRequest
Represents a request theOidcUserService
uses when initiating a request to the UserInfo Endpoint.- Since:
- 5.0
- See Also:
ClientRegistration
,OAuth2AccessToken
,OidcIdToken
,OidcUserService
-
-
Constructor Summary
Constructors Constructor Description OidcUserRequest(ClientRegistration clientRegistration, OAuth2AccessToken accessToken, OidcIdToken idToken)
Constructs anOidcUserRequest
using the provided parameters.OidcUserRequest(ClientRegistration clientRegistration, OAuth2AccessToken accessToken, OidcIdToken idToken, java.util.Map<java.lang.String,java.lang.Object> additionalParameters)
Constructs anOidcUserRequest
using the provided parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OidcIdToken
getIdToken()
Returns theID Token
containing claims about the user.-
Methods inherited from class org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest
getAccessToken, getAdditionalParameters, getClientRegistration
-
-
-
-
Constructor Detail
-
OidcUserRequest
public OidcUserRequest(ClientRegistration clientRegistration, OAuth2AccessToken accessToken, OidcIdToken idToken)
Constructs anOidcUserRequest
using the provided parameters.- Parameters:
clientRegistration
- the client registrationaccessToken
- the access token credentialidToken
- the ID Token
-
OidcUserRequest
public OidcUserRequest(ClientRegistration clientRegistration, OAuth2AccessToken accessToken, OidcIdToken idToken, java.util.Map<java.lang.String,java.lang.Object> additionalParameters)
Constructs anOidcUserRequest
using the provided parameters.- Parameters:
clientRegistration
- the client registrationaccessToken
- the access token credentialidToken
- the ID TokenadditionalParameters
- the additional parameters, may be empty- Since:
- 5.1
-
-
Method Detail
-
getIdToken
public OidcIdToken getIdToken()
Returns theID Token
containing claims about the user.- Returns:
- the
OidcIdToken
containing claims about the user.
-
-