Package-level declarations

Types

data class GetTokenOptions(val template: String? = null, val skipCache: Boolean = false, val expirationBuffer: Long = 10)

Options for configuring session token retrieval behavior.

Session

@Serializable

data class Session(val id: String, val status: Session.SessionStatus = SessionStatus.UNKNOWN, val expireAt: Long, val abandonAt: Long? = null, val lastActiveAt: Long, val latestActivity: SessionActivity? = null, val lastActiveOrganizationId: String? = null, val actor: JsonElement? = null, val user: User? = null, val publicUserData: PublicUserData? = null, val factorVerificationAge: List<Int>? = null, val createdAt: Long, val updatedAt: Long, val tasks: List<SessionTask> = emptyList(), val lastActiveToken: TokenResource? = null)

The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.

SessionActivity

@Serializable

data class SessionActivity(val id: String, val browserName: String? = null, val browserVersion: String? = null, val deviceType: String? = null, val ipAddress: String? = null, val city: String? = null, val country: String? = null, val isMobile: Boolean? = null)

A SessionActivity object will provide information about the user's location, device and browser.

SessionTask

@Serializable

data class SessionTask(val key: String)

Properties

isThisDevice

val Session.isThisDevice: Boolean

Convenience accessor to tell if the given session is the current device. Used mostly for constructing the User profile security view.

Functions

delete

suspend fun Session.delete(): ClerkResult<Client, ClerkErrorResponse>

Deletes the current session.

fetchToken

suspend fun Session.fetchToken(options: GetTokenOptions = GetTokenOptions()): ClerkResult<TokenResource, ClerkErrorResponse>

Fetches a fresh JWT for the session.

revoke

suspend fun Session.revoke(): ClerkResult<Session, ClerkErrorResponse>

Revokes the current session.