Interface OidcUser

All Superinterfaces:

AuthenticatedPrincipal, ClaimAccessor, IdTokenClaimAccessor, OAuth2AuthenticatedPrincipal, OAuth2User, StandardClaimAccessor

All Known Implementing Classes:

DefaultOidcUser

public interface OidcUser
extends OAuth2User, IdTokenClaimAccessor

A representation of a user Principal that is registered with an OpenID Connect 1.0 Provider.

An OidcUser contains "claims" about the authentication of the End-User. The claims are aggregated from the OidcIdToken and the OidcUserInfo (if available).

Implementation instances of this interface represent an AuthenticatedPrincipal which is associated to an Authentication object and may be accessed via Authentication.getPrincipal().

Since:

5.0

See Also:

• DefaultOidcUser
• OAuth2User
• OidcIdToken
• OidcUserInfo
• IdTokenClaimAccessor
• StandardClaimAccessor
• ID Token
• Standard Claims

Method Summary

Modifier and Type	Method	Description
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.

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

Method Details

getClaims

Map<String,Object> getClaims()

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

Specified by:

getClaims in interface ClaimAccessor

Returns:

a Map of claims about the user

getUserInfo

@Nullable OidcUserInfo getUserInfo()

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

Returns:

the OidcUserInfo containing claims about the user, or null

getIdToken

OidcIdToken getIdToken()

Returns the ID Token containing claims about the user.

Returns:

the OidcIdToken containing claims about the user.