Package org.springframework.security.oauth2.client.oidc.userinfo

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 the OidcUserService 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, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken, org.springframework.security.oauth2.core.oidc.OidcIdToken idToken)	Constructs an OidcUserRequest using the provided parameters.
OidcUserRequest(ClientRegistration clientRegistration, org.springframework.security.oauth2.core.OAuth2AccessToken accessToken, org.springframework.security.oauth2.core.oidc.OidcIdToken idToken, Map<String,Object> additionalParameters)	Constructs an OidcUserRequest using the provided parameters.

Method Summary

Modifier and Type	Method	Description
org.springframework.security.oauth2.core.oidc.OidcIdToken	getIdToken()	Returns the ID Token containing claims about the user.

Methods inherited from class org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest

getAccessToken, getAdditionalParameters, getClientRegistration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OidcUserRequest

public OidcUserRequest(ClientRegistration clientRegistration,
 org.springframework.security.oauth2.core.OAuth2AccessToken accessToken,
 org.springframework.security.oauth2.core.oidc.OidcIdToken idToken)

Constructs an OidcUserRequest using the provided parameters.

Parameters:

clientRegistration - the client registration

accessToken - the access token credential

idToken - the ID Token

OidcUserRequest

public OidcUserRequest(ClientRegistration clientRegistration,
 org.springframework.security.oauth2.core.OAuth2AccessToken accessToken,
 org.springframework.security.oauth2.core.oidc.OidcIdToken idToken,
 Map<String,Object> additionalParameters)

Constructs an OidcUserRequest using the provided parameters.

Parameters:

clientRegistration - the client registration

accessToken - the access token credential

idToken - the ID Token

additionalParameters - the additional parameters, may be empty

Since:

5.1

Method Details

getIdToken

public org.springframework.security.oauth2.core.oidc.OidcIdToken getIdToken()

Returns the ID Token containing claims about the user.

Returns:

the OidcIdToken containing claims about the user.