Clerk Android API/com.clerk.api.signin/SignIn

SignIn

@Serializable

data class SignIn(val id: String, val status: SignIn.Status = Status.UNKNOWN, val supportedIdentifiers: List<String>? = null, val identifier: String? = null, val supportedFirstFactors: List<Factor>? = null, val supportedSecondFactors: List<Factor>? = null, val firstFactorVerification: Verification? = null, val secondFactorVerification: Verification? = null, val userData: SignIn.UserData? = null, val createdSessionId: String? = null)

The SignIn object holds the state of the current sign-in process and provides helper methods to navigate and complete the sign-in lifecycle. This includes managing the first and second factor verifications, as well as creating a new session.

The sign-in process follows these steps:

Initiate the Sign-In Process
Collect the user's authentication information and pass the appropriate parameters to the SignIn.create method to start the sign-in.
Prepare for First Factor Verification
Users must complete a first factor verification. This can include:

Providing a password
Using an email link
Entering a one-time code (OTP)
Authenticating with a Web3 wallet address
Providing proof of identity through an external social account (SSO/OAuth).

Complete First Factor Verification
Attempt to verify the user's first factor authentication details.
Prepare for Second Factor Verification (Optional)
If multi-factor authentication (MFA) is enabled for your application, prepare the second factor verification for users who have set up 2FA for their account.
Complete Second Factor Verification
Attempt to verify the user's second factor authentication details if MFA is required.

Constructors

SignIn

constructor(id: String, status: SignIn.Status = Status.UNKNOWN, supportedIdentifiers: List<String>? = null, identifier: String? = null, supportedFirstFactors: List<Factor>? = null, supportedSecondFactors: List<Factor>? = null, firstFactorVerification: Verification? = null, secondFactorVerification: Verification? = null, userData: SignIn.UserData? = null, createdSessionId: String? = null)

Types

AttemptFirstFactorParams

sealed interface AttemptFirstFactorParams

A sealed interface defining parameter objects for attempting first factor verification in the sign-in process.

AttemptSecondFactorParams

sealed interface AttemptSecondFactorParams

Parameters for second factor authentication strategies.

AuthenticateWithRedirectParams

sealed interface AuthenticateWithRedirectParams

Parameters for authenticating with a redirect to an external provider.

Companion

object Companion

CreateParams

object CreateParams

Container object for sign-in creation parameters and strategies.

CredentialType

@Serializable

enum CredentialType : Enum<SignIn.CredentialType>

Enumerates the types of credential requests supported by the service.

PrepareFirstFactorParams

sealed interface PrepareFirstFactorParams

A sealed interface defining parameter objects for preparing first factor verification.

PrepareSecondFactorParams

@Serializable

data class PrepareSecondFactorParams(val strategy: String = PHONE_CODE, val phoneNumberId: String? = null, val emailAddressId: String? = null)

A parameter object for preparing the second factor verification.

PrepareSecondFactorStrategy

sealed class PrepareSecondFactorStrategy

ResetPasswordParams

@Serializable

data class ResetPasswordParams(val password: String, val signOutOfOtherSessions: Boolean = false)

Parameters for resetting a user's password during the sign-in process.

Status

@Serializable

enum Status : Enum<SignIn.Status>

Represents the status of a sign-in process.

UserData

@Serializable

data class UserData(val firstName: String? = null, val lastName: String? = null, val imageUrl: String? = null, val hasImage: Boolean? = null)

An object containing information about the user of the current sign-in. This property is populated only once an identifier is given to the SignIn object.

Properties

createdSessionId

@SerialName(value = "created_session_id")

val createdSessionId: String?

The identifier of the session that was created upon completion of the current sign-in.

firstFactorVerification

@SerialName(value = "first_factor_verification")

val firstFactorVerification: Verification?

The state of the verification process for the selected first factor.

val id: String

Unique identifier for this sign in.

identifier

val identifier: String?

The authentication identifier value for the current sign-in.

resetPasswordFactor

val SignIn.resetPasswordFactor: Factor?

secondFactorVerification

@SerialName(value = "second_factor_verification")

val secondFactorVerification: Verification?

The state of the verification process for the selected second factor.

startingFirstFactor

val SignIn.startingFirstFactor: Factor?

Determines the starting first factor for a sign-in attempt based on the preferred sign-in strategy.

startingSecondFactor

val SignIn.startingSecondFactor: Factor?

status

val status: SignIn.Status

The status of the current sign-in.

supportedFirstFactors

@SerialName(value = "supported_first_factors")

val supportedFirstFactors: List<Factor>?

Array of the first factors that are supported in the current sign-in.

supportedIdentifiers

@SerialName(value = "supported_identifiers")

val supportedIdentifiers: List<String>?

Array of all the authentication identifiers that are supported for this sign in.

supportedSecondFactors

@SerialName(value = "supported_second_factors")

val supportedSecondFactors: List<Factor>?

Array of the second factors that are supported in the current sign-in.

userData

@SerialName(value = "user_data")

val userData: SignIn.UserData?

An object containing information about the user of the current sign-in.

Functions

alternativeFirstFactors

fun SignIn.alternativeFirstFactors(factor: Factor? = null): List<Factor>

Retrieves a list of alternative first factors for the current sign-in attempt, excluding the specified factor and certain strategy types.

alternativeSecondFactors

fun SignIn.alternativeSecondFactors(factor: Factor): List<Factor>

Returns a list of alternative second factors, sorted by a predefined order, excluding the provided factor.

attemptFirstFactor

suspend fun SignIn.attemptFirstFactor(params: SignIn.AttemptFirstFactorParams): ClerkResult<SignIn, ClerkErrorResponse>

Attempts to complete the first factor verification process.

attemptSecondFactor

suspend fun SignIn.attemptSecondFactor(params: SignIn.AttemptSecondFactorParams): ClerkResult<SignIn, ClerkErrorResponse>

Attempts to complete the second factor verification process.

get

suspend fun SignIn.get(rotatingTokenNonce: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Retrieves the current state of the SignIn object from the server.

identifyingFirstFactor

fun SignIn.identifyingFirstFactor(strategy: String): Factor?

prepareFirstFactor

suspend fun SignIn.prepareFirstFactor(params: SignIn.PrepareFirstFactorParams): ClerkResult<SignIn, ClerkErrorResponse>

Begins the first factor verification process.

prepareSecondFactor

suspend fun SignIn.prepareSecondFactor(phoneNumberId: String? = null, emailAddressId: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Prepares the second factor verification for the sign-in process.

reload

suspend fun SignIn.reload(rotatingTokenNonce: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Reloads the SignIn from the server.

resetPassword

suspend fun SignIn.resetPassword(newPassword: String, signOutOfOtherSessions: Boolean = false): ClerkResult<SignIn, ClerkErrorResponse>

Resets the password after verification.

sendCode

suspend fun SignIn.sendCode(block: SendCodeBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Sends a verification code to the specified email or phone.

sendEmailCode

suspend fun SignIn.sendEmailCode(emailAddressId: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Sends a verification code to the user's email address for first factor authentication.

sendMfaEmailCode

suspend fun SignIn.sendMfaEmailCode(emailAddressId: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Sends a verification code to the user's email address for MFA (second factor) authentication.

sendMfaPhoneCode

suspend fun SignIn.sendMfaPhoneCode(phoneNumberId: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Sends a verification code to the user's phone number for MFA (second factor) authentication.

sendPhoneCode

suspend fun SignIn.sendPhoneCode(phoneNumberId: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Sends a verification code to the user's phone number for first factor authentication.

sendResetPasswordCode

suspend fun SignIn.sendResetPasswordCode(block: SendCodeBuilder.() -> Unit): ClerkResult<SignIn, ClerkErrorResponse>

Sends a password reset verification code.

verifyCode

suspend fun SignIn.verifyCode(code: String): ClerkResult<SignIn, ClerkErrorResponse>

Verifies the first factor with the provided code.

verifyMfaCode

suspend fun SignIn.verifyMfaCode(code: String, type: MfaType): ClerkResult<SignIn, ClerkErrorResponse>

Verifies MFA with the provided code and type.

verifyWithPasskey

suspend fun SignIn.verifyWithPasskey(credential: String): ClerkResult<SignIn, ClerkErrorResponse>

Verifies the first factor with a passkey credential.

verifyWithPassword

suspend fun SignIn.verifyWithPassword(password: String): ClerkResult<SignIn, ClerkErrorResponse>

Verifies the first factor with a password.