Package org.springframework.security.oauth2.client.oidc.authentication.logout

Interface LogoutTokenClaimAccessor

All Superinterfaces:

ClaimAccessor

All Known Implementing Classes:

OidcLogoutToken

public interface LogoutTokenClaimAccessor
extends ClaimAccessor

A ClaimAccessor for the "claims" that can be returned in OIDC Logout Tokens

Since:

6.2

See Also:

• OidcLogoutToken
• OIDC Back-Channel Logout Token

Method Summary

Modifier and Type	Method	Description
default List<String>	getAudience()	Returns the Audience(s) (aud) that this ID Token is intended for.
default Map<String,Object>	getEvents()	Returns a Map that identifies this token as a logout token
default String	getId()	Returns the JWT ID (jti) claim which provides a unique identifier for the JWT.
default Instant	getIssuedAt()	Returns the time at which the ID Token was issued (iat).
default URL	getIssuer()	Returns the Issuer identifier (iss).
default String	getSessionId()	Returns a String value (sid) representing the OIDC Provider session
default String	getSubject()	Returns the Subject identifier (sub).

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

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

Method Details

getIssuer

default URL getIssuer()

Returns the Issuer identifier (iss).

Returns:

the Issuer identifier

getSubject

default String getSubject()

Returns the Subject identifier (sub).

Returns:

the Subject identifier

getAudience

default List<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

getIssuedAt

default Instant getIssuedAt()

Returns the time at which the ID Token was issued (iat).

Returns:

the time at which the ID Token was issued

getEvents

default Map<String,Object> getEvents()

Returns a Map that identifies this token as a logout token

Returns:

the identifying Map

getSessionId

default String getSessionId()

Returns a String value (sid) representing the OIDC Provider session

Returns:

the value representing the OIDC Provider session

getId

default String getId()

Returns the JWT ID (jti) claim which provides a unique identifier for the JWT.

Returns:

the JWT ID claim which provides a unique identifier for the JWT