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

PrepareFirstFactorParams

sealed interface PrepareFirstFactorParams

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

This interface is used to specify which verification strategy should be prepared before attempting the first factor authentication.

Inheritors

ResetPasswordEmailCode

ResetPasswordPhoneCode

Types

@Serializable

data class EmailCode(val emailAddressId: String, val strategy: String = EMAIL_CODE) : SignIn.PrepareFirstFactorParams

@Serializable

data class EnterpriseSSO(val strategy: String = ENTERPRISE_SSO, val redirectUrl: String = RedirectConfiguration.DEFAULT_REDIRECT_URL) : SignIn.PrepareFirstFactorParams

@Serializable

data class OAuth(val strategy: String, val redirectUrl: String) : SignIn.PrepareFirstFactorParams

@Serializable

data class Passkey(val strategy: String = PASSKEY) : SignIn.PrepareFirstFactorParams

@Serializable

data class PhoneCode(val phoneNumberId: String, val strategy: String = PHONE_CODE) : SignIn.PrepareFirstFactorParams

ResetPasswordEmailCode

@Serializable

data class ResetPasswordEmailCode(val emailAddressId: String, val strategy: String = RESET_PASSWORD_EMAIL_CODE) : SignIn.PrepareFirstFactorParams

ResetPasswordPhoneCode

@Serializable

data class ResetPasswordPhoneCode(val phoneNumberId: String, val strategy: String = RESET_PASSWORD_PHONE_CODE) : SignIn.PrepareFirstFactorParams

Properties

abstract val strategy: String

Enumeration of available first factor verification strategies.