auth-foundation/com.okta.authfoundation.credential.kmp/TokenData

TokenData

class TokenData(val id: String, val tokenType: String, val expiresIn: Int, val accessToken: String, val scope: String?, val refreshToken: String?, val idToken: String?, val deviceSecret: String?, val issuedTokenType: String?, val configuration: OAuth2ClientConfiguration, val issuedAt: Long = configuration.clock.currentTimeEpochSecond() - expiresIn) : TokenInfo

Default cross-platform implementation of TokenInfo.

Used on JVM and other non-Android KMP targets where the Android-specific Token is not available.

Constructors

constructor(id: String, tokenType: String, expiresIn: Int, accessToken: String, scope: String?, refreshToken: String?, idToken: String?, deviceSecret: String?, issuedTokenType: String?, configuration: OAuth2ClientConfiguration, issuedAt: Long = configuration.clock.currentTimeEpochSecond() - expiresIn)

Properties

open override val accessToken: String

The access token.

open override val clientId: String

The client id of the application that minted this token.

val configuration: OAuth2ClientConfiguration

open override val deviceSecret: String?

The device secret, if requested.

open override val expiresIn: Int

The expiration duration in seconds for this token.

open override val id: String

Unique identifier for this token.

open override val idToken: String?

The ID token, if requested.

val issuedAt: Long

Epoch-second timestamp when the token was issued by the authorization server.

issuedTokenType

open override val issuedTokenType: String?

The issued token type, if returned.

open override val issuerUrl: String

The issuer url of the token.

open override val refreshToken: String?

The refresh token, if requested.

open override val scope: String?

The scopes granted when this token was minted.

open override val tokenType: String

The string type of the token (e.g. Bearer).

Functions

accessTokenIfNotExpired

fun accessTokenIfNotExpired(): String?

Returns the access token string if it has not expired, or null if it has.

fun copy(id: String = this.id, refreshToken: String? = this.refreshToken, deviceSecret: String? = this.deviceSecret): TokenData

Creates a copy with optionally replaced fields.

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

Equality is based on the token payload fields only (tokenType, expiresIn, accessToken, scope, refreshToken, idToken, deviceSecret, issuedTokenType).

open override fun hashCode(): Int