Package-level declarations

Types

@Serializable(with = SignInSerializer::class)

data class SignIn

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.

Properties

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?

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.

authenticateWithEnterpriseSso

suspend fun SignIn.authenticateWithEnterpriseSso(transferable: Boolean = true, redirectUrl: String = RedirectConfiguration.DEFAULT_REDIRECT_URL): ClerkResult<OAuthResult, ClerkErrorResponse>

Continues this sign-in with Enterprise SSO.

authenticateWithOAuth

suspend fun SignIn.authenticateWithOAuth(provider: OAuthProvider, transferable: Boolean = true, redirectUrl: String = RedirectConfiguration.DEFAULT_REDIRECT_URL): ClerkResult<OAuthResult, ClerkErrorResponse>

Continues this sign-in with an OAuth provider.

authenticateWithPasskey

suspend fun SignIn.authenticateWithPasskey(allowedCredentialIds: List<String> = emptyList()): ClerkResult<SignIn, ClerkErrorResponse>

Authenticates this sign-in with a passkey.

authenticateWithPreparedRedirect

suspend fun SignIn.authenticateWithPreparedRedirect(transferable: Boolean = true): ClerkResult<OAuthResult, ClerkErrorResponse>

Continues a prepared redirect verification.

get

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

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

prepareFirstFactor

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

Begins the first factor verification process.

prepareSecondFactor

suspend fun SignIn.prepareSecondFactor(strategy: SignIn.PrepareSecondFactorStrategy): ClerkResult<SignIn, ClerkErrorResponse>

Prepares an explicit second-factor strategy, including passkeys.

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.

sendEmailLink

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

Sends a verification link 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.

sendResetPasswordEmailCode

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

Sends a password reset code to one of the user's email addresses.

sendResetPasswordPhoneCode

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

Sends a password reset code to one of the user's phone numbers.

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.