public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAccessor
AbstractOAuth2Token
representing an OpenID Connect Core
1.0 ID Token.
The OidcIdToken
is a security token that contains "claims" about the
authentication of an End-User by an Authorization Server.
AbstractOAuth2Token
,
IdTokenClaimAccessor
,
StandardClaimAccessor
,
ID Token,
Standard
Claims,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
OidcIdToken.Builder
A builder for
OidcIdToken s |
Constructor and Description |
---|
OidcIdToken(java.lang.String tokenValue,
java.time.Instant issuedAt,
java.time.Instant expiresAt,
java.util.Map<java.lang.String,java.lang.Object> claims)
Constructs a
OidcIdToken using the provided parameters. |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.lang.Object> |
getClaims()
Returns a set of claims that may be used for assertions.
|
static OidcIdToken.Builder |
withTokenValue(java.lang.String tokenValue)
Create a
OidcIdToken.Builder based on the given token value |
equals, getExpiresAt, getIssuedAt, getTokenValue, hashCode
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getAccessTokenHash, getAudience, getAuthenticatedAt, getAuthenticationContextClass, getAuthenticationMethods, getAuthorizationCodeHash, getAuthorizedParty, getExpiresAt, getIssuedAt, getIssuer, getNonce, getSubject
getAddress, getBirthdate, getEmail, getEmailVerified, getFamilyName, getFullName, getGender, getGivenName, getLocale, getMiddleName, getNickName, getPhoneNumber, getPhoneNumberVerified, getPicture, getPreferredUsername, getProfile, getUpdatedAt, getWebsite, getZoneInfo
containsClaim, getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL
public OidcIdToken(java.lang.String tokenValue, java.time.Instant issuedAt, java.time.Instant expiresAt, java.util.Map<java.lang.String,java.lang.Object> claims)
OidcIdToken
using the provided parameters.tokenValue
- the ID Token valueissuedAt
- the time at which the ID Token was issued (iat)
expiresAt
- the expiration time (exp)
on or after which the ID Token
MUST NOT be acceptedclaims
- the claims about the authentication of the End-Userpublic java.util.Map<java.lang.String,java.lang.Object> getClaims()
ClaimAccessor
getClaims
in interface ClaimAccessor
Map
of claimspublic static OidcIdToken.Builder withTokenValue(java.lang.String tokenValue)
OidcIdToken.Builder
based on the given token valuetokenValue
- the token value to useOidcIdToken.Builder
for further configuration