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

activeSession

val activeSession: Session?

The current session only if its status is ACTIVE.

activeUser

val activeUser: User?

The current user only if the session status is ACTIVE.

applicationName

val applicationName: String?

auth

val auth: Auth

The Auth namespace providing all authentication entry points.

client

lateinit var client: Client

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

clientFlow

val clientFlow: StateFlow<Client?>

Reactive state for the current client.

customTheme

var customTheme: ClerkTheme?

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

debugMode

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

isBranded

val isBranded: Boolean

Indicates whether Clerk branding is enabled for the application.

isEmailEnabled

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.

isInitialized

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

isSignedIn

val isSignedIn: Boolean

Indicates whether a user is currently signed in.

isUserNameEnabled

val isUserNameEnabled: Boolean

isUsernameImmutable

val isUsernameImmutable: Boolean

locale

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.

mfaIsEnabled

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.

organization

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

passkeyIsEnabled

val passkeyIsEnabled: Boolean

passwordIsEnabled

val passwordIsEnabled: Boolean

privacyPolicyUrl

val privacyPolicyUrl: String?

The URL of the Privacy Policy page for the application.

proxyUrl

var proxyUrl: String?

Optional proxy URL for network requests.

publishableKey

var publishableKey: String?

The publishable key from Clerk Dashboard used for API authentication.

session

val session: Session?

The current user session, regardless of status.

sessionFlow

val sessionFlow: StateFlow<Session?>

Reactive state for the current user session.

sessionsFlow

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.

telemetryEnabled

var telemetryEnabled: Boolean

Whether to enable telemetry for the SDK.

termsUrl

val termsUrl: String?

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

user

val user: User?

The current user, regardless of session status.

userFlow

val userFlow: StateFlow<User?>

Reactive state for the currently authenticated user.

version

val version: String

The current version of the Clerk Android SDK.

Functions

attachActivity

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.

getDeviceToken

fun getDeviceToken(): String?

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

initialize

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.

refreshClient

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

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

reinitialize

fun reinitialize(): Boolean

Manually triggers a reinitialization attempt after a failed initialization.

reset

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.