Package com.okta.authfoundation.claims

Types

Link copied to clipboard
interface ClaimsProvider

Used by classes that contains OAuth2 claims.

Properties

Link copied to clipboard
val ClaimsProvider.active: Boolean?

Indicates whether the token is active or not.

Link copied to clipboard
val ClaimsProvider.audience: String?

The audience of the token.

Link copied to clipboard
val ClaimsProvider.authContextClassReference: String?

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

Link copied to clipboard
val ClaimsProvider.authMethodsReference: List<String>?

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

Link copied to clipboard
val ClaimsProvider.clientId: String?

The ID of the client associated with the token.

Link copied to clipboard
val ClaimsProvider.deviceId: String?

The ID of the device associated with the token.

Link copied to clipboard
val ClaimsProvider.email: String?

The user's email address.

Link copied to clipboard
val ClaimsProvider.expirationTime: Int?

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

Link copied to clipboard
val ClaimsProvider.familyName: String?

The person's family, or last, name.

Link copied to clipboard
val ClaimsProvider.gender: String?

The user's gender.

Link copied to clipboard
val ClaimsProvider.givenName: String?

The person's given, or first, name.

Link copied to clipboard
val ClaimsProvider.issuedAt: Int?

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

Link copied to clipboard
val ClaimsProvider.issuer: String?

The issuer of the token.

Link copied to clipboard
val ClaimsProvider.jwtId: String?

The identifier of the token.

Link copied to clipboard
val ClaimsProvider.middleName: String?

The person's middle name.

Link copied to clipboard
val ClaimsProvider.name: String?

The full name of the resource.

Link copied to clipboard
val ClaimsProvider.nickname: String?

The person's nickname.

Link copied to clipboard
val ClaimsProvider.notBefore: Int?

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
val ClaimsProvider.phoneNumber: String?

The user's phone number.

Link copied to clipboard
val ClaimsProvider.preferredUsername: String?

The person's preferred username.

Link copied to clipboard
val ClaimsProvider.scope: String?

A space-delimited list of scopes.

Link copied to clipboard
val ClaimsProvider.subject: String?

The subject of the resource, if available.

Link copied to clipboard
val ClaimsProvider.tokenType: String?

The type of token. The value is always Bearer.

Link copied to clipboard
val ClaimsProvider.userId: String?

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
val ClaimsProvider.username: String?

The username associated with the token.