Clerk Android API/com.clerk.api/Clerk

Clerk

object Clerk

Main entrypoint class for the Clerk SDK.

Provides access to authentication state, user information, and core functionality for managing user sessions and sign-in flows.

Properties

val activeSession: Session?

The current session only if its status is ACTIVE.

val activeUser: User?

The current user only if the session status is ACTIVE.

applicationName

val applicationName: String?

The Auth namespace providing all authentication entry points.

val billing: Billing

Reads Plans, Subscriptions, statements, payment attempts, and credits.

biometricCredentialPromptAfterSignInIsEnabled

val biometricCredentialPromptAfterSignInIsEnabled: Boolean

Indicates whether the biometric credential enrollment prompt should be offered after sign-in.

biometricCredentialPromptAfterSignUpIsEnabled

val biometricCredentialPromptAfterSignUpIsEnabled: Boolean

Indicates whether the biometric credential enrollment prompt should be offered after sign-up.

biometricCredentials

val biometricCredentials: BiometricCredentials

The main entry point for biometric credential operations.

biometricSignInIsEnabled

val biometricSignInIsEnabled: Boolean

Indicates whether biometric sign-in is enabled for this instance.

lateinit var client: Client

The Client object representing the current device and its authentication state.

val clientFlow: StateFlow<Client?>

Reactive state for the current client.

commerceSettings

val commerceSettings: CommerceSettings

Billing flags from /v1/environment.

var customTheme: ClerkTheme?

Clerk theme configuration for customizing the appearance of authentication UI components.

var debugMode: Boolean

Enable for additional debugging signals and logging.

deleteSelfIsEnabled

val deleteSelfIsEnabled: Boolean

enabledFirstFactorAttributes

val enabledFirstFactorAttributes: List<String>

A list of enabled first factor attributes, sorted by priority.

initializationError

val initializationError: StateFlow<Throwable?>

Reactive state for initialization errors.

instanceEnvironmentType

val instanceEnvironmentType: InstanceEnvironmentType

isAuthFlowComplete

val isAuthFlowComplete: Boolean

Whether authentication and Clerk-owned post-authentication steps are currently complete.

isAuthFlowCompleteFlow

val isAuthFlowCompleteFlow: StateFlow<Boolean>

Reactive state indicating whether authentication and Clerk-owned post-authentication steps are complete.

val isBranded: Boolean

Indicates whether Clerk branding is enabled for the application.

val isEmailEnabled: Boolean

isEmailImmutable

val isEmailImmutable: Boolean

isFirstNameEnabled

val isFirstNameEnabled: Boolean

Indicates whether the 'First Name' field is enabled for user profiles.

isGoogleOneTapEnabled

val isGoogleOneTapEnabled: Boolean

Indicates whether Google One Tap sign-in is enabled for the application.

val isInitialized: StateFlow<Boolean>

Reactive state indicating whether the Clerk SDK has completed initialization.

isLastNameEnabled

val isLastNameEnabled: Boolean

Indicates whether the last name field is enabled for user profiles.

isPhoneNumberEnabled

val isPhoneNumberEnabled: Boolean

isPhoneNumberImmutable

val isPhoneNumberImmutable: Boolean

val isSignedIn: Boolean

Indicates whether a user is currently signed in.

isUserNameEnabled

val isUserNameEnabled: Boolean

isUsernameImmutable

val isUsernameImmutable: Boolean

val locale: StateFlow<String?>

The active locale for the current session.

mfaAuthenticatorAppIsEnabled

val mfaAuthenticatorAppIsEnabled: Boolean

mfaBackupCodeIsEnabled

val mfaBackupCodeIsEnabled: Boolean

Indicates whether MFA (Multi-Factor Authentication) via backup codes is enabled.

val mfaIsEnabled: Boolean

mfaPhoneCodeIsEnabled

val mfaPhoneCodeIsEnabled: Boolean

Indicates whether MFA (Multi-Factor Authentication) via phone code is enabled.

multiSessionModeIsEnabled

val multiSessionModeIsEnabled: Boolean

Indicates whether this Clerk instance allows multiple sessions on the same client.

multiSessionModeIsEnabledFlow

val multiSessionModeIsEnabledFlow: StateFlow<Boolean>

Reactive state indicating whether this Clerk instance allows multiple sessions on the same client.

val organization: Organization?

The active organization for the current session.

organizationAdminDeleteIsEnabled

val organizationAdminDeleteIsEnabled: Boolean

organizationCreationDefaultsIsEnabled

val organizationCreationDefaultsIsEnabled: Boolean

organizationDefaultRoleKey

val organizationDefaultRoleKey: String?

organizationDomainEnrollmentModes

val organizationDomainEnrollmentModes: List<String>

organizationDomainsIsEnabled

val organizationDomainsIsEnabled: Boolean

organizationIsEnabled

val organizationIsEnabled: Boolean

organizationLogoUrl

val organizationLogoUrl: String?

The image URL for the application logo used in authentication UI components.

organizationLogoUrlFlow

val organizationLogoUrlFlow: StateFlow<String?>

Reactive image URL for the application logo used in authentication UI components.

organizationMembership

val organizationMembership: OrganizationMembership?

The current user's membership in the active organization.

organizationSelectionIsForced

val organizationSelectionIsForced: Boolean

organizationSlugIsEnabled

val organizationSlugIsEnabled: Boolean

passkeyAutofillIsEnabled

val passkeyAutofillIsEnabled: Boolean

passkeyFirstFactorIsEnabled

val passkeyFirstFactorIsEnabled: Boolean

passkeyIsEnabled

val passkeyIsEnabled: Boolean

passwordIsEnabled

val passwordIsEnabled: Boolean

privacyPolicyUrl

val privacyPolicyUrl: String?

The URL of the Privacy Policy page for the application.

var proxyUrl: String?

Optional proxy URL for network requests.

var publishableKey: String?

The publishable key from Clerk Dashboard used for API authentication.

restoreCredentials

val restoreCredentials: RestoreCredentials

The main entry point for Google Play Restore Credentials operations.

val session: Session?

The current user session, regardless of status.

val sessionFlow: StateFlow<Session?>

Reactive state for the current user session.

val sessionsFlow: StateFlow<List<Session>>

Reactive state for all sessions available on the current client.

shouldShowDevelopmentModeWarning

val shouldShowDevelopmentModeWarning: Boolean

Indicates whether prebuilt UI components should display the development mode warning.

socialProviders

val socialProviders: Map<String, UserSettings.SocialConfig>

Map of available social authentication providers configured for this application.

val supportEmail: String?

The support email address configured for this application in the Clerk Dashboard.

telemetryEnabled

var telemetryEnabled: Boolean

Whether to enable telemetry for the SDK.

val termsUrl: String?

The URL of the Terms of Service page for the application.

val user: User?

The current user, regardless of session status.

val userFlow: StateFlow<User?>

Reactive state for the currently authenticated user.

val version: String

The current version of the Clerk Android SDK.

Functions

fun attachActivity(activity: Activity)

Provides the current foreground Activity to Clerk explicitly.

clearDeviceToken

suspend fun clearDeviceToken(): ClerkResult<Unit, ClerkErrorResponse>

Clears the stored device token and refreshes the native Clerk state.

fun getDeviceToken(): String?

Returns the current device token from encrypted storage, or null if unavailable.

fun has(role: String? = null, permission: String? = null, feature: String? = null, plan: String? = null, reverification: ReverificationConfig? = null): Boolean

Returns whether the signed-in user passes the given authorization checks against the activeSession. Returns false when no user is signed in or when the current session is not ACTIVE (e.g., PENDING while session tasks are outstanding). See Session.checkAuthorization.

fun initialize(context: Context, publishableKey: String)

fun initialize(context: Context, publishableKey: String, options: ClerkConfigurationOptions? = null, theme: ClerkTheme? = null)

Initializes the Clerk SDK with the provided configuration.

markAuthFlowComplete

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun markAuthFlowComplete()

markAuthFlowPending

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun markAuthFlowPending()

suspend fun refreshClient(): ClerkResult<Client, ClerkErrorResponse>

Refreshes the current client and updates Clerk's reactive auth state.

registerAuthFlow

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun registerAuthFlow(): AuthFlowRegistration?

fun reinitialize(): Boolean

Manually triggers a reinitialization attempt after a failed initialization.

reloadFromSharedStorage

suspend fun reloadFromSharedStorage(): Boolean

Reloads Clerk authentication state persisted by a same-signed sibling app.

fun reset()

Clears the active Clerk configuration and local runtime state.

switchConfiguration

fun switchConfiguration(context: Context, publishableKey: String, options: ClerkConfigurationOptions? = null, theme: ClerkTheme? = null)

Switches the active Clerk configuration in the current process.

updateDeviceToken

suspend fun updateDeviceToken(deviceToken: String): ClerkResult<Unit, ClerkErrorResponse>

Updates the stored device token and refreshes the native Clerk state.