Clerk Android API/com.clerk.api.session

Package-level declarations

Types

GetTokenOptions

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

Options for configuring session token retrieval behavior.

@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 currentTask: SessionTask? = null, 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.

@Serializable

data class SessionTask(val key: String)

enum SessionTaskKey : Enum<SessionTaskKey>

SessionVerification

@Serializable

data class SessionVerification(val id: String? = null, val status: SessionVerification.Status = Status.UNKNOWN, val level: SessionVerification.Level = Level.UNKNOWN, val session: Session? = null, val supportedFirstFactors: List<Factor>? = null, val supportedSecondFactors: List<Factor>? = null, val firstFactorVerification: Verification? = null, val secondFactorVerification: Verification? = null)

Represents the state of an in-session reverification (step-up) flow.

Properties

hasMfaRequiredTask

val Session.hasMfaRequiredTask: Boolean

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.

val SessionTask.parsedKey: SessionTaskKey

val Session.pendingTaskKey: SessionTaskKey?

requiresForcedMfa

val Session.requiresForcedMfa: Boolean

Functions

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

Deletes the current session.

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

Fetches a fresh JWT for the session.

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

Revokes the current session.

suspend fun Session.sendEmailCode(emailAddressId: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Sends a verification code to the email address for first-factor reverification.

sendMfaPhoneCode

suspend fun Session.sendMfaPhoneCode(phoneNumberId: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Sends an MFA code to the phone number for second-factor reverification.

suspend fun Session.sendPhoneCode(phoneNumberId: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Sends a verification code to the phone number for first-factor reverification.

startEnterpriseSso

suspend fun Session.startEnterpriseSso(emailAddressId: String? = null, enterpriseConnectionId: String? = null, redirectUrl: String? = null): ClerkResult<SessionVerification, ClerkErrorResponse>

Starts Enterprise SSO for first-factor reverification.

startVerification

suspend fun Session.startVerification(level: SessionVerification.Level): ClerkResult<SessionVerification, ClerkErrorResponse>

Starts an in-session reverification flow.

verifyWithBackupCode

suspend fun Session.verifyWithBackupCode(code: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Verifies the current session with a backup code.

verifyWithEmailCode

suspend fun Session.verifyWithEmailCode(code: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Verifies the current session with an email code.

verifyWithMfaPhoneCode

suspend fun Session.verifyWithMfaPhoneCode(code: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Verifies the current session with a phone code as a second factor.

verifyWithPasskey

suspend fun Session.verifyWithPasskey(allowedCredentialIds: List<String> = emptyList()): ClerkResult<SessionVerification, ClerkErrorResponse>

Verifies the current session with a passkey via Android Credential Manager.

verifyWithPassword

suspend fun Session.verifyWithPassword(password: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Verifies the current session by asking the user to re-enter their password.

verifyWithPhoneCode

suspend fun Session.verifyWithPhoneCode(code: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Verifies the current session with a phone code as a first factor.

suspend fun Session.verifyWithTOTP(code: String): ClerkResult<SessionVerification, ClerkErrorResponse>

Verifies the current session with a TOTP code.