Class OidcIdToken

java.lang.Object

org.springframework.security.oauth2.core.AbstractOAuth2Token

org.springframework.security.oauth2.core.oidc.OidcIdToken

All Implemented Interfaces:

Serializable, ClaimAccessor, OAuth2Token, IdTokenClaimAccessor, StandardClaimAccessor

public class OidcIdToken
extends AbstractOAuth2Token
implements IdTokenClaimAccessor

An implementation of an 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.

Since:

5.0

See Also:

• AbstractOAuth2Token
• IdTokenClaimAccessor
• StandardClaimAccessor
• ID Token
• Standard Claims
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OidcIdToken.Builder	A builder for OidcIdTokens.

Constructor Summary

Constructors

Constructor	Description
OidcIdToken(String tokenValue, @Nullable Instant issuedAt, @Nullable Instant expiresAt, Map<String,Object> claims)	Constructs a OidcIdToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getClaims()	Returns a set of claims that may be used for assertions.
static OidcIdToken.Builder	withTokenValue(String tokenValue)	Create a OidcIdToken.Builder based on the given token value.

Methods inherited from class AbstractOAuth2Token

equals, getExpiresAt, getIssuedAt, getTokenValue, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ClaimAccessor

getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, hasClaim

Methods inherited from interface IdTokenClaimAccessor

getAccessTokenHash, getAudience, getAuthenticatedAt, getAuthenticationContextClass, getAuthenticationMethods, getAuthorizationCodeHash, getAuthorizedParty, getExpiresAt, getIssuedAt, getIssuer, getNonce, getSubject

Methods inherited from interface StandardClaimAccessor

getAddress, getBirthdate, getEmail, getEmailVerified, getFamilyName, getFullName, getGender, getGivenName, getLocale, getMiddleName, getNickName, getPhoneNumber, getPhoneNumberVerified, getPicture, getPreferredUsername, getProfile, getUpdatedAt, getWebsite, getZoneInfo

Constructor Details

OidcIdToken

public OidcIdToken(String tokenValue,
 @Nullable Instant issuedAt,
 @Nullable Instant expiresAt,
 Map<String,Object> claims)

Constructs a OidcIdToken using the provided parameters.

Parameters:

tokenValue - the ID Token value

issuedAt - the time at which the ID Token was issued (iat), may be null

expiresAt - the expiration time (exp) on or after which the ID Token MUST NOT be accepted, may be null

claims - the claims about the authentication of the End-User

Method Details

getClaims

public Map<String,Object> getClaims()

Description copied from interface: ClaimAccessor

Returns a set of claims that may be used for assertions.

Specified by:

getClaims in interface ClaimAccessor

Returns:

a Map of claims

withTokenValue

public static OidcIdToken.Builder withTokenValue(String tokenValue)

Create a OidcIdToken.Builder based on the given token value.

Parameters:

tokenValue - the token value to use

Returns:

the OidcIdToken.Builder for further configuration

Since:

5.3