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

Interface OidcUser

All Superinterfaces:

AuthenticatedPrincipal, ClaimAccessor, IdTokenClaimAccessor, OAuth2User, java.io.Serializable, 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 IdToken and optionally the UserInfo.

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, IdToken, UserInfo, IdTokenClaimAccessor, StandardClaimAccessor, OpenID Connect Core 1.0, ID Token, Standard Claims

Method Summary

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

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, getClaimAsString, getClaimAsURL

Method Detail

getClaims

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

Specified by:

getClaims in interface ClaimAccessor