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

applicationName

val applicationName: String?

client

lateinit var client: Client

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

debugMode

var debugMode: Boolean

Enable for additional debugging signals and logging.

firstNameIsEnabled

val firstNameIsEnabled: Boolean

Indicates whether first name is enabled in user settings for this application.

isInitialized

val isInitialized: StateFlow<Boolean>

Reactive state indicating whether the Clerk SDK has completed initialization.

isSignedIn

val isSignedIn: Boolean

Indicates whether a user is currently signed in.

lastNameIsEnabled

val lastNameIsEnabled: Boolean

Indicates whether last name is enabled in user settings for this application.

logoUrl

val logoUrl: String?

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

mfaAuthenticatorAppIsEnabled

val mfaAuthenticatorAppIsEnabled: Boolean

Indicates whether authenticator app MFA is enabled for this application.

mfaIsEnabled

val mfaIsEnabled: Boolean

Indicates whether multi-factor authentication (MFA) is enabled for this application.

passkeyIsEnabled

val passkeyIsEnabled: Boolean

Indicates whether passkey authentication is enabled for this application.

passwordIsEnabled

val passwordIsEnabled: Boolean

Indicates whether password authentication is enabled for this application.

session

val session: Session?

The currently active user session.

signIn

val signIn: SignIn?

The current sign-in attempt, if one is in progress.

signUp

val signUp: SignUp?

The current sign-up attempt, if one is in progress.

socialProviders

val socialProviders: Map<String, UserSettings.SocialConfig>

Map of available social authentication providers configured for this application.

user

val user: User?

The currently authenticated user.

usernameIsEnabled

val usernameIsEnabled: Boolean

Indicates whether username authentication is enabled for this application.

Functions

initialize

fun initialize(context: Context, publishableKey: String)

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

Initializes the Clerk SDK with the provided configuration.

signOut

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

Signs out the currently authenticated user.