All Superinterfaces:

ClaimAccessor, StandardClaimAccessor

All Known Subinterfaces:

OidcUser

All Known Implementing Classes:

DefaultOidcUser, OidcIdToken
```
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, StandardClaimNames, IdTokenClaimNames, OidcIdToken, ID Token, Standard Claims

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default java.lang.String`	`getAccessTokenHash()`	Returns the Access Token hash value `(at_hash)`.
`default java.util.List<java.lang.String>`	`getAudience()`	Returns the Audience(s) `(aud)` that this ID Token is intended for.
`default java.time.Instant`	`getAuthenticatedAt()`	Returns the time when the End-User authentication occurred `(auth_time)`.
`default java.lang.String`	`getAuthenticationContextClass()`	Returns the Authentication Context Class Reference `(acr)`.
`default java.util.List<java.lang.String>`	`getAuthenticationMethods()`	Returns the Authentication Methods References `(amr)`.
`default java.lang.String`	`getAuthorizationCodeHash()`	Returns the Authorization Code hash value `(c_hash)`.
`default java.lang.String`	`getAuthorizedParty()`	Returns the Authorized party `(azp)` to which the ID Token was issued.
`default java.time.Instant`	`getExpiresAt()`	Returns the Expiration time `(exp)` on or after which the ID Token MUST NOT be accepted.
`default java.time.Instant`	`getIssuedAt()`	Returns the time at which the ID Token was issued `(iat)`.
`default java.net.URL`	`getIssuer()`	Returns the Issuer identifier `(iss)`.
`default java.lang.String`	`getNonce()`	Returns a `String` value `(nonce)` used to associate a Client session with an ID Token, and to mitigate replay attacks.
`default java.lang.String`	`getSubject()`	Returns the Subject identifier `(sub)`.

Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor
containsClaim, getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims, hasClaim

Methods inherited from interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor
getAddress, getBirthdate, getEmail, getEmailVerified, getFamilyName, getFullName, getGender, getGivenName, getLocale, getMiddleName, getNickName, getPhoneNumber, getPhoneNumberVerified, getPicture, getPreferredUsername, getProfile, getUpdatedAt, getWebsite, getZoneInfo

- Method Detail
  - getIssuer
```
default java.net.URL getIssuer()
```
    Returns the Issuer identifier (iss).
    
    Returns:
    
    the Issuer identifier
  - getSubject
```
default java.lang.String getSubject()
```
    Returns the Subject identifier (sub).
    
    Specified by:
    
    getSubject in interface StandardClaimAccessor
    
    Returns:
    
    the Subject identifier
  - getAudience
```
default java.util.List<java.lang.String> getAudience()
```
    Returns the Audience(s) (aud) that this ID Token is intended for.
    
    Returns:
    
    the Audience(s) that this ID Token is intended for
  - getExpiresAt
```
default java.time.Instant getExpiresAt()
```
    Returns the Expiration time (exp) on or after which the ID Token MUST NOT be accepted.
    
    Returns:
    
    the Expiration time on or after which the ID Token MUST NOT be accepted
  - getIssuedAt
```
default java.time.Instant getIssuedAt()
```
    Returns the time at which the ID Token was issued (iat).
    
    Returns:
    
    the time at which the ID Token was issued
  - getAuthenticatedAt
```
default java.time.Instant getAuthenticatedAt()
```
    Returns the time when the End-User authentication occurred (auth_time).
    
    Returns:
    
    the time when the End-User authentication occurred
  - getNonce
```
default java.lang.String getNonce()
```
    Returns a String value (nonce) used to associate a Client session with an ID Token, and to mitigate replay attacks.
    
    Returns:
    
    the nonce used to associate a Client session with an ID Token
  - getAuthenticationContextClass
```
default java.lang.String getAuthenticationContextClass()
```
    Returns the Authentication Context Class Reference (acr).
    
    Returns:
    
    the Authentication Context Class Reference
  - getAuthenticationMethods
```
default java.util.List<java.lang.String> getAuthenticationMethods()
```
    Returns the Authentication Methods References (amr).
    
    Returns:
    
    the Authentication Methods References
  - getAuthorizedParty
```
default java.lang.String getAuthorizedParty()
```
    Returns the Authorized party (azp) to which the ID Token was issued.
    
    Returns:
    
    the Authorized party to which the ID Token was issued
  - getAccessTokenHash
```
default java.lang.String getAccessTokenHash()
```
    Returns the Access Token hash value (at_hash).
    
    Returns:
    
    the Access Token hash value
  - getAuthorizationCodeHash
```
default java.lang.String getAuthorizationCodeHash()
```
    Returns the Authorization Code hash value (c_hash).
    
    Returns:
    
    the Authorization Code hash value

Interface IdTokenClaimAccessor

Method Summary

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

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

Method Detail

getIssuer

getSubject

getAudience

getExpiresAt

getIssuedAt

getAuthenticatedAt

getNonce

getAuthenticationContextClass

getAuthenticationMethods

getAuthorizedParty

getAccessTokenHash

getAuthorizationCodeHash