ClaimsProvider

interface ClaimsProvider

Used by classes that contains OAuth2 claims.

This provides common conveniences for interacting with information within those claims.

Inheritors

Properties

Link copied to clipboard

Indicates whether the token is active or not.

Link copied to clipboard

The audience of the token.

Link copied to clipboard

The acr claim, Authentication Context Class Reference, associated with the token.

Link copied to clipboard

The amr claim, Authentication Methods References, associated with the token.

Link copied to clipboard

The ID of the client associated with the token.

Link copied to clipboard

The ID of the device associated with the token.

Link copied to clipboard

The user's email address.

Link copied to clipboard

The expiration time of the token in seconds since January 1, 1970 UTC.

Link copied to clipboard

The person's family, or last, name.

Link copied to clipboard

The user's gender.

Link copied to clipboard

The person's given, or first, name.

Link copied to clipboard

The issuing time of the token in seconds since January 1, 1970 UTC.

Link copied to clipboard

The issuer of the token.

Link copied to clipboard

The identifier of the token.

Link copied to clipboard

The person's middle name.

Link copied to clipboard

The full name of the resource.

Link copied to clipboard

The person's nickname.

Link copied to clipboard

Identifies the time (a timestamp in seconds since January 1, 1970 UTC) before which the token must not be accepted for processing.

Link copied to clipboard

The user's phone number.

Link copied to clipboard

The person's preferred username.

Link copied to clipboard

A space-delimited list of scopes.

Link copied to clipboard

The subject of the resource, if available.

Link copied to clipboard

The type of token. The value is always Bearer.

Link copied to clipboard

The user ID. This parameter is returned only if the token is an access token and the subject is an end user.

Link copied to clipboard

The username associated with the token.

Functions

Link copied to clipboard
abstract fun availableClaims(): Set<String>

List all claims present in the claims data.

Link copied to clipboard
abstract fun <T> deserializeClaim(claim: String, deserializationStrategy: DeserializationStrategy<T>): T?

Deserialize a specific claim from the claims data in a type safe way.

Link copied to clipboard
abstract fun <T> deserializeClaims(deserializationStrategy: DeserializationStrategy<T>): T

Used to get access to the claims data in a type safe way.