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

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.

This class is used to specify the strategy and related details for preparing a second factor authentication method. For example, if you want to use a one-time code sent to the user's phone, you would set the strategy to "phone_code".

Constructors

PrepareSecondFactorParams

constructor(strategy: String = PHONE_CODE, phoneNumberId: String? = null, emailAddressId: String? = null)

Types

Companion

object Companion

Properties

emailAddressId

@SerialName(value = "email_address_id")

val emailAddressId: String?

The ID of the email address to use for email_code verification. This is typically retrieved from the supportedSecondFactors list on the SignIn object.

phoneNumberId

@SerialName(value = "phone_number_id")

val phoneNumberId: String?

The ID of the phone number to use for phone_code verification. This is typically retrieved from the supportedSecondFactors list on the SignIn object.

strategy

val strategy: String

The strategy used for second factor verification.

PrepareSecondFactorParams

See also

Constructors

Types

Properties