org.springframework.security.oauth2.oidc.core

Interface IdTokenClaimAccessor

All Superinterfaces:

ClaimAccessor, StandardClaimAccessor

All Known Subinterfaces:

OidcUser

All Known Implementing Classes:

DefaultOidcUser, IdToken

public interface IdTokenClaimAccessor
extends StandardClaimAccessor

A ClaimAccessor for the "Claims" that can be returned in the ID Token which provides information about the authentication of an End-User by an Authorization Server.

Since:

5.0

See Also:

ClaimAccessor, StandardClaimAccessor, StandardClaim, IdTokenClaim, IdToken, ID Token, Standard Claims

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getAccessTokenHash()
default java.lang.String[]	getAudience()
default java.time.Instant	getAuthenticatedAt()
default java.lang.String	getAuthenticationContextClass()
default java.lang.String[]	getAuthenticationMethods()
default java.lang.String	getAuthorizationCodeHash()
default java.lang.String	getAuthorizedParty()
default java.time.Instant	getExpiresAt()
default java.time.Instant	getIssuedAt()
default java.net.URL	getIssuer()
default java.lang.String	getNonce()
default java.lang.String	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, getClaims

Method Detail

getIssuer

default java.net.URL getIssuer()

getSubject

default java.lang.String getSubject()

Specified by:

getSubject in interface StandardClaimAccessor

getAudience

default java.lang.String[] getAudience()

getExpiresAt

default java.time.Instant getExpiresAt()

getIssuedAt

default java.time.Instant getIssuedAt()

getAuthenticatedAt

default java.time.Instant getAuthenticatedAt()

getNonce

default java.lang.String getNonce()

getAuthenticationContextClass

default java.lang.String getAuthenticationContextClass()

getAuthenticationMethods

default java.lang.String[] getAuthenticationMethods()

getAuthorizedParty

default java.lang.String getAuthorizedParty()

getAccessTokenHash

default java.lang.String getAccessTokenHash()

getAuthorizationCodeHash

default java.lang.String getAuthorizationCodeHash()