forgerock-auth

4.8.0

forgerock-auth/org.forgerock.android.auth/AccessToken

AccessToken

@Serializable

data class AccessToken(val value: String = "", val tokenType: String? = null, val scope: AccessToken.Scope? = null, val expiresIn: Long = 0, val refreshToken: String? = null, val idToken: String? = null, var expiration: Date? = null, val sessionToken: SSOToken? = null) : Token

Models an OAuth2 access token.

Constructors

constructor(value: String = "", tokenType: String? = null, scope: AccessToken.Scope? = null, expiresIn: Long = 0, refreshToken: String? = null, idToken: String? = null, expiration: Date? = null, sessionToken: SSOToken? = null)

Types

AccessTokenBuilder

class AccessTokenBuilder

Builder class for AccessToken.

object Companion

@Serializable

class Scope : HashSet<String>

Represents the authorization scope of the access token.

Properties

@Serializable(with = DateSerializer::class)

var expiration: Date?

The date and time when the access token expires.

val expiresIn: Long = 0

The duration (in seconds) for which the access token is valid.

val idToken: String? = null

The ID token associated with the access token.

val isExpired: Boolean

Checks if the access token is expired.

@Transient

var isPersisted: Boolean

val refreshToken: String? = null

The refresh token which can be used to obtain new access tokens.

@Serializable(with = ScopeSerializer::class)

val scope: AccessToken.Scope? = null

The scope of the access token which defines the resources that the access token can access.

@Serializable(with = SSOTokenSerializer::class)

val sessionToken: SSOToken? = null

The session token associated with the access token.

val tokenType: String? = null

The type of the token (usually "Bearer").

open override val value: String

The value of the access token.

Functions

fun isExpired(threshold: Long): Boolean

Checks if the access token is expired.

fun toJson(): String