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

Class DefaultOidcUser

java.lang.Object

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

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

All Implemented Interfaces:

AuthenticatedPrincipal, ClaimAccessor, OAuth2User, IdTokenClaimAccessor, StandardClaimAccessor, OidcUser

public class DefaultOidcUser
extends DefaultOAuth2User
implements OidcUser

The default implementation of an OidcUser.

The claim used for accessing the "name" of the user Principal via getClaims() is IdTokenClaim.SUB.

Since:

5.0

See Also:

OidcUser, DefaultOAuth2User, IdToken, UserInfo

Constructor Summary

Constructors

Constructor and Description
DefaultOidcUser(java.util.Set<GrantedAuthority> authorities, IdToken idToken)
DefaultOidcUser(java.util.Set<GrantedAuthority> authorities, IdToken idToken, java.lang.String nameAttributeKey)
DefaultOidcUser(java.util.Set<GrantedAuthority> authorities, IdToken idToken, UserInfo userInfo)
DefaultOidcUser(java.util.Set<GrantedAuthority> authorities, IdToken idToken, UserInfo userInfo, java.lang.String nameAttributeKey)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getClaims()
IdToken	getIdToken()
UserInfo	getUserInfo()

Methods inherited from class org.springframework.security.oauth2.core.user.DefaultOAuth2User

equals, getAttributes, getAuthorities, getName, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.oauth2.oidc.core.user.OidcUser

collectClaims

Methods inherited from interface org.springframework.security.oauth2.core.user.OAuth2User

getAttributes, getAuthorities

Methods inherited from interface org.springframework.security.core.AuthenticatedPrincipal

getName

Methods inherited from interface org.springframework.security.oauth2.oidc.core.IdTokenClaimAccessor

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

Methods inherited from interface org.springframework.security.oauth2.oidc.core.StandardClaimAccessor

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

Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor

containsClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL

Constructor Detail

DefaultOidcUser

public DefaultOidcUser(java.util.Set<GrantedAuthority> authorities,
                       IdToken idToken)

DefaultOidcUser

public DefaultOidcUser(java.util.Set<GrantedAuthority> authorities,
                       IdToken idToken,
                       java.lang.String nameAttributeKey)

DefaultOidcUser

public DefaultOidcUser(java.util.Set<GrantedAuthority> authorities,
                       IdToken idToken,
                       UserInfo userInfo)

DefaultOidcUser

public DefaultOidcUser(java.util.Set<GrantedAuthority> authorities,
                       IdToken idToken,
                       UserInfo userInfo,
                       java.lang.String nameAttributeKey)

Method Detail

getClaims

public java.util.Map<java.lang.String,java.lang.Object> getClaims()

Specified by:

getClaims in interface ClaimAccessor

Specified by:

getClaims in interface OidcUser

getIdToken

public IdToken getIdToken()

getUserInfo

public UserInfo getUserInfo()