Clerk Android API/com.clerk.api.auth

Package-level declarations

Types

Auth

class Auth

Main Auth class providing all authentication entry points.

AuthEvent

sealed interface AuthEvent

Represents authentication events emitted by the Auth class.

Functions

signIn

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

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

signInWithAccountPortal

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

Signs in via account portal.

signInWithEnterpriseSso

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

Signs in with Enterprise SSO.

signInWithIdToken

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

Signs in with an ID token from an identity provider.

signInWithOAuth

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

Signs in with OAuth provider.

signInWithOtp

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

Signs in with OTP - automatically sends the verification code.

signInWithPasskey

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

Signs in with passkey.

signInWithPassword

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

Signs in with password authentication.

signInWithTicket

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

Signs in with a ticket.

signUp

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

Creates a new sign-up with the provided details.

signUpWithAccountPortal

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

Signs up via account portal.

signUpWithEnterpriseSso

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

Signs up with Enterprise SSO.

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 Auth.signUpWithOAuth(provider: OAuthProvider): ClerkResult<OAuthResult, ClerkErrorResponse>

Signs up with OAuth provider.

signUpWithTicket

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

Signs up with a ticket.