Clerk Android API/com.clerk.api.auth/Auth

Auth

class Auth

Main Auth class providing all authentication entry points.

Access via Clerk.auth.

This class provides a centralized, DSL-style API for all authentication operations including:

Sign in with various methods (password, OTP, OAuth, passkey, etc.)
Sign up with various methods
Session management (sign out, set active session, get tokens)
Deep link handling for OAuth/SSO callbacks

Example usage:

// Sign in with email (requires separate sendCode call)
val signIn = clerk.auth.signIn { email = "user@email.com" }

// Sign in with password
val signIn = clerk.auth.signInWithPassword {
    identifier = "user@email.com"
    password = "password"
}

// Sign in with OTP (automatically sends code)
val signIn = clerk.auth.signInWithOtp { email = "user@email.com" }

// Sign out
clerk.auth.signOut()

Properties

val currentSignIn: SignIn?

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

val currentSignUp: SignUp?

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

val events: Flow<AuthEvent>

Flow of authentication events.

Functions

suspend fun getToken(options: GetTokenOptions? = null): ClerkResult<String, ClerkErrorResponse>

Gets a token for the current session.

fun handle(uri: Uri?): Boolean

Handles OAuth/SSO deep link callbacks.

suspend fun revokeSession(session: Session): ClerkResult<Unit, ClerkErrorResponse>

Revokes a session.

suspend fun setActive(sessionId: String, organizationId: String? = null): ClerkResult<Session, ClerkErrorResponse>

Sets the active session.

suspend fun signIn(block: SignInIdentifierBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Starts sign-in with an identifier (email, phone, or username).

suspend fun Auth.signIn(block: SignInIdentifierBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Starts sign-in with an identifier (email, phone, or username).

signInWithAccountPortal

suspend fun signInWithAccountPortal(): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in via account portal.

signInWithAccountPortal

suspend fun Auth.signInWithAccountPortal(): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in via account portal.

signInWithEnterpriseSso

suspend fun signInWithEnterpriseSso(block: EnterpriseSsoBuilder.() -> Unit): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in with Enterprise SSO.

signInWithEnterpriseSso

suspend fun Auth.signInWithEnterpriseSso(block: EnterpriseSsoBuilder.() -> Unit): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in with Enterprise SSO.

signInWithIdToken

suspend fun signInWithIdToken(block: SignInWithIdTokenBuilder.() -> Unit): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in with an ID token from an identity provider.

signInWithIdToken

suspend fun Auth.signInWithIdToken(block: SignInWithIdTokenBuilder.() -> Unit): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in with an ID token from an identity provider.

signInWithOAuth

suspend fun signInWithOAuth(provider: OAuthProvider): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in with OAuth provider.

signInWithOAuth

suspend fun Auth.signInWithOAuth(provider: OAuthProvider): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs in with OAuth provider.

suspend fun signInWithOtp(block: SignInWithOtpBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with OTP - automatically sends the verification code.

suspend fun Auth.signInWithOtp(block: SignInWithOtpBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with OTP - automatically sends the verification code.

signInWithPasskey

suspend fun signInWithPasskey(): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with passkey.

signInWithPasskey

suspend fun Auth.signInWithPasskey(): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with passkey.

signInWithPassword

suspend fun signInWithPassword(block: SignInWithPasswordBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with password authentication.

signInWithPassword

suspend fun Auth.signInWithPassword(block: SignInWithPasswordBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with password authentication.

signInWithTicket

suspend fun signInWithTicket(ticket: String): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with a ticket.

signInWithTicket

suspend fun Auth.signInWithTicket(ticket: String): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with a ticket.

suspend fun signOut(sessionId: String? = null): ClerkResult<Unit, ClerkErrorResponse>

Signs out the current session or a specific session.

suspend fun signUp(block: SignUpBuilder.() -> Unit): ClerkResult<SignUp, ClerkErrorResponse>

Creates a new sign-up with the provided details.

suspend fun Auth.signUp(block: SignUpBuilder.() -> Unit): ClerkResult<SignUp, ClerkErrorResponse>

Creates a new sign-up with the provided details.

signUpWithAccountPortal

suspend fun signUpWithAccountPortal(): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs up via account portal.

signUpWithAccountPortal

suspend fun Auth.signUpWithAccountPortal(): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs up via account portal.

signUpWithEnterpriseSso

suspend fun signUpWithEnterpriseSso(block: EnterpriseSsoBuilder.() -> Unit): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs up with Enterprise SSO.

signUpWithEnterpriseSso

suspend fun Auth.signUpWithEnterpriseSso(block: EnterpriseSsoBuilder.() -> Unit): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs up with Enterprise SSO.

signUpWithIdToken

suspend fun signUpWithIdToken(token: String, provider: IdTokenProvider, block: SignUpWithIdTokenBuilder.() -> Unit = {}): ClerkResult<SignUp, ClerkErrorResponse>

Signs up with an ID token from an identity provider.

signUpWithIdToken

suspend fun Auth.signUpWithIdToken(token: String, provider: IdTokenProvider, block: SignUpWithIdTokenBuilder.() -> Unit = {}): ClerkResult<SignUp, ClerkErrorResponse>

Signs up with an ID token from an identity provider.

signUpWithOAuth

suspend fun signUpWithOAuth(provider: OAuthProvider): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs up with OAuth provider.

signUpWithOAuth

suspend fun Auth.signUpWithOAuth(provider: OAuthProvider): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs up with OAuth provider.

signUpWithTicket

suspend fun signUpWithTicket(ticket: String): ClerkResult<SignUp, ClerkErrorResponse>

Signs up with a ticket.

signUpWithTicket

suspend fun Auth.signUpWithTicket(ticket: String): ClerkResult<SignUp, ClerkErrorResponse>

Signs up with a ticket.