Class DefaultOidcUser

java.lang.Object

org.springframework.security.oauth2.core.user.DefaultOAuth2User

org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

All Implemented Interfaces:

Serializable, AuthenticatedPrincipal, ClaimAccessor, OAuth2AuthenticatedPrincipal, IdTokenClaimAccessor, StandardClaimAccessor, OidcUser, OAuth2User

public class DefaultOidcUser
extends DefaultOAuth2User
implements OidcUser

The default implementation of an OidcUser.

The default claim used for accessing the "name" of the user Principal from getClaims() is IdTokenClaimNames.SUB.

Since:

5.0

See Also:

• OidcUser
• DefaultOAuth2User
• OidcIdToken
• OidcUserInfo
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities, OidcIdToken idToken)	Constructs a DefaultOidcUser using the provided parameters.
DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities, OidcIdToken idToken, String nameAttributeKey)	Constructs a DefaultOidcUser using the provided parameters.
DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities, OidcIdToken idToken, @Nullable OidcUserInfo userInfo)	Constructs a DefaultOidcUser using the provided parameters.
DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities, OidcIdToken idToken, @Nullable OidcUserInfo userInfo, String nameAttributeKey)	Constructs a DefaultOidcUser using the provided parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
Map<String,Object>	getClaims()	Returns the claims about the user.
OidcIdToken	getIdToken()	Returns the ID Token containing claims about the user.
@Nullable OidcUserInfo	getUserInfo()	Returns the UserInfo containing claims about the user, or null if not present.
int	hashCode()

Methods inherited from class DefaultOAuth2User

getAttributes, getAuthorities, getName, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AuthenticatedPrincipal

getName

Methods inherited from interface ClaimAccessor

getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, hasClaim

Methods inherited from interface IdTokenClaimAccessor

getAccessTokenHash, getAudience, getAuthenticatedAt, getAuthenticationContextClass, getAuthenticationMethods, getAuthorizationCodeHash, getAuthorizedParty, getExpiresAt, getIssuedAt, getIssuer, getNonce, getSubject

Methods inherited from interface OAuth2AuthenticatedPrincipal

getAttribute, getAttributes, getAuthorities

Methods inherited from interface StandardClaimAccessor

getAddress, getBirthdate, getEmail, getEmailVerified, getFamilyName, getFullName, getGender, getGivenName, getLocale, getMiddleName, getNickName, getPhoneNumber, getPhoneNumberVerified, getPicture, getPreferredUsername, getProfile, getUpdatedAt, getWebsite, getZoneInfo

Constructor Details

DefaultOidcUser

public DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities,
 OidcIdToken idToken)

Constructs a DefaultOidcUser using the provided parameters.

Parameters:

authorities - the authorities granted to the user, may be null

idToken - the ID Token containing claims about the user

DefaultOidcUser

public DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities,
 OidcIdToken idToken,
 String nameAttributeKey)

Constructs a DefaultOidcUser using the provided parameters.

Parameters:

authorities - the authorities granted to the user, may be null

idToken - the ID Token containing claims about the user

nameAttributeKey - the key used to access the user's "name" from DefaultOAuth2User.getAttributes()

DefaultOidcUser

public DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities,
 OidcIdToken idToken,
 @Nullable OidcUserInfo userInfo)

Constructs a DefaultOidcUser using the provided parameters.

Parameters:

authorities - the authorities granted to the user, may be null

idToken - the ID Token containing claims about the user

userInfo - the UserInfo containing claims about the user, may be null

DefaultOidcUser

public DefaultOidcUser(@Nullable Collection<? extends GrantedAuthority> authorities,
 OidcIdToken idToken,
 @Nullable OidcUserInfo userInfo,
 String nameAttributeKey)

Constructs a DefaultOidcUser using the provided parameters.

Parameters:

authorities - the authorities granted to the user, may be null

idToken - the ID Token containing claims about the user

userInfo - the UserInfo containing claims about the user, may be null

nameAttributeKey - the key used to access the user's "name" from DefaultOAuth2User.getAttributes()

Method Details

getClaims

public Map<String,Object> getClaims()

Description copied from interface: OidcUser

Returns the claims about the user. The claims are aggregated from OidcUser.getIdToken() and OidcUser.getUserInfo() (if available).

Specified by:

getClaims in interface ClaimAccessor

Specified by:

getClaims in interface OidcUser

Returns:

a Map of claims about the user

getIdToken

public OidcIdToken getIdToken()

Description copied from interface: OidcUser

Returns the ID Token containing claims about the user.

Specified by:

getIdToken in interface OidcUser

Returns:

the OidcIdToken containing claims about the user.

getUserInfo

public @Nullable OidcUserInfo getUserInfo()

Description copied from interface: OidcUser

Returns the UserInfo containing claims about the user, or null if not present.

Specified by:

getUserInfo in interface OidcUser

Returns:

the OidcUserInfo containing claims about the user, or null

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class DefaultOAuth2User

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultOAuth2User