Interface IdTokenClaimAccessor

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:

  • Method Details

    • getIssuer

      default @Nullable URL getIssuer()
      Returns the Issuer identifier (iss), or null if it does not exist.
      Returns:
      the Issuer identifier, or null if it does not exist

    • getSubject

      default @Nullable String getSubject()
      Returns the Subject identifier (sub), or null if it does not exist.
      Specified by:
      getSubject in interface StandardClaimAccessor
      Returns:
      the Subject identifier, or null if it does not exist

    • getAudience

      default @Nullable List<String> getAudience()
      Returns the Audience(s) (aud) that this ID Token is intended for, or null if it does not exist.
      Returns:
      the Audience(s) that this ID Token is intended for, or null if it does not exist

    • getExpiresAt

      default @Nullable Instant getExpiresAt()
      Returns the Expiration time (exp) on or after which the ID Token MUST NOT be accepted, or null if it does not exist.
      Returns:
      the Expiration time on or after which the ID Token MUST NOT be accepted, or null if it does not exist

    • getIssuedAt

      default @Nullable Instant getIssuedAt()
      Returns the time at which the ID Token was issued (iat), or null if it does not exist.
      Returns:
      the time at which the ID Token was issued, or null if it does not exist

    • getAuthenticatedAt

      default @Nullable Instant getAuthenticatedAt()
      Returns the time when the End-User authentication occurred (auth_time), or null if it does not exist.
      Returns:
      the time when the End-User authentication occurred, or null if it does not exist

    • getNonce

      default @Nullable String getNonce()
      Returns a String value (nonce) used to associate a Client session with an ID Token, and to mitigate replay attacks, or null if it does not exist.
      Returns:
      the nonce used to associate a Client session with an ID Token, or null if it does not exist

    • getAuthenticationContextClass

      default @Nullable String getAuthenticationContextClass()
      Returns the Authentication Context Class Reference (acr), or null if it does not exist.
      Returns:
      the Authentication Context Class Reference, or null if it does not exist

    • getAuthenticationMethods

      default @Nullable List<String> getAuthenticationMethods()
      Returns the Authentication Methods References (amr), or null if it does not exist.
      Returns:
      the Authentication Methods References, or null if it does not exist

    • getAuthorizedParty

      default @Nullable String getAuthorizedParty()
      Returns the Authorized party (azp) to which the ID Token was issued, or null if it does not exist.
      Returns:
      the Authorized party to which the ID Token was issued, or null if it does not exist

    • getAccessTokenHash

      default @Nullable String getAccessTokenHash()
      Returns the Access Token hash value (at_hash), or null if it does not exist.
      Returns:
      the Access Token hash value, or null if it does not exist

    • getAuthorizationCodeHash

      default @Nullable String getAuthorizationCodeHash()
      Returns the Authorization Code hash value (c_hash), or null if it does not exist.
      Returns:
      the Authorization Code hash value, or null if it does not exist