Interface IdTokenClaimAccessor
- All Superinterfaces:
ClaimAccessor
,StandardClaimAccessor
- All Known Subinterfaces:
OidcUser
- All Known Implementing Classes:
DefaultOidcUser
,OidcIdToken
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 Summary
Modifier and TypeMethodDescriptiondefault String
Returns the Access Token hash value(at_hash)
.Returns the Audience(s)(aud)
that this ID Token is intended for.default Instant
Returns the time when the End-User authentication occurred(auth_time)
.default String
Returns the Authentication Context Class Reference(acr)
.Returns the Authentication Methods References(amr)
.default String
Returns the Authorization Code hash value(c_hash)
.default String
Returns the Authorized party(azp)
to which the ID Token was issued.default Instant
Returns the Expiration time(exp)
on or after which the ID Token MUST NOT be accepted.default Instant
Returns the time at which the ID Token was issued(iat)
.default URL
Returns the Issuer identifier(iss)
.default String
getNonce()
Returns aString
value(nonce)
used to associate a Client session with an ID Token, and to mitigate replay attacks.default String
Returns the Subject identifier(sub)
.Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor
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 Details
-
getIssuer
Returns the Issuer identifier(iss)
.- Returns:
- the Issuer identifier
-
getSubject
Returns the Subject identifier(sub)
.- Specified by:
getSubject
in interfaceStandardClaimAccessor
- Returns:
- the Subject identifier
-
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
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
Returns the time at which the ID Token was issued(iat)
.- Returns:
- the time at which the ID Token was issued
-
getAuthenticatedAt
Returns the time when the End-User authentication occurred(auth_time)
.- Returns:
- the time when the End-User authentication occurred
-
getNonce
Returns aString
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
Returns the Authentication Context Class Reference(acr)
.- Returns:
- the Authentication Context Class Reference
-
getAuthenticationMethods
Returns the Authentication Methods References(amr)
.- Returns:
- the Authentication Methods References
-
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
Returns the Access Token hash value(at_hash)
.- Returns:
- the Access Token hash value
-
getAuthorizationCodeHash
Returns the Authorization Code hash value(c_hash)
.- Returns:
- the Authorization Code hash value
-