auth-foundation/com.okta.authfoundation.jwt/Jwt

Jwt

class Jwt : ClaimsProvider

Represents a Json Web Token.

Properties

active

val ClaimsProvider.active: Boolean?

Indicates whether the token is active or not.

algorithm

val algorithm: String

Identifies the digital signature algorithm used.

audience

val ClaimsProvider.audience: String?

The audience of the token.

authContextClassReference

val ClaimsProvider.authContextClassReference: String?

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

authMethodsReference

val ClaimsProvider.authMethodsReference: List<String>?

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

clientId

val ClaimsProvider.clientId: String?

The ID of the client associated with the token.

deviceId

val ClaimsProvider.deviceId: String?

The ID of the device associated with the token.

val ClaimsProvider.email: String?

The user's email address.

expirationTime

val ClaimsProvider.expirationTime: Int?

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

familyName

val ClaimsProvider.familyName: String?

The person's family, or last, name.

gender

val ClaimsProvider.gender: String?

The user's gender.

givenName

val ClaimsProvider.givenName: String?

The person's given, or first, name.

issuedAt

val ClaimsProvider.issuedAt: Int?

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

issuer

val ClaimsProvider.issuer: String?

The issuer of the token.

jwtId

val ClaimsProvider.jwtId: String?

The identifier of the token.

keyId

val keyId: String

Identifies the public key used to verify the ID token.

middleName

val ClaimsProvider.middleName: String?

The person's middle name.

name

val ClaimsProvider.name: String?

The full name of the resource.

nickname

val ClaimsProvider.nickname: String?

The person's nickname.

notBefore

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.

phoneNumber

val ClaimsProvider.phoneNumber: String?

The user's phone number.

preferredUsername

val ClaimsProvider.preferredUsername: String?

The person's preferred username.

rawValue

val rawValue: String

The raw value in standard JWT format.

scope

val ClaimsProvider.scope: String?

A space-delimited list of scopes.

signature

val signature: String

The base64 encoded signature.

subject

val ClaimsProvider.subject: String?

The subject of the resource, if available.

tokenType

val ClaimsProvider.tokenType: String?

The type of token. The value is always Bearer.

userId

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.

username

val ClaimsProvider.username: String?

The username associated with the token.

Functions

availableClaims

open override fun availableClaims(): Set<String>

List all claims present in the claims data.

deserializeClaim

open override fun <T> deserializeClaim(claim: String, deserializationStrategy: DeserializationStrategy<T>): T?

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

deserializeClaims

open override fun <T> deserializeClaims(deserializationStrategy: DeserializationStrategy<T>): T

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

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

hasValidSignature

suspend fun hasValidSignature(jwks: Jwks): Boolean

Validates the Jwt.signature against the Jwks.

toString

open override fun toString(): String