Clerk Android API/com.clerk.api.network.model.factor/Factor

Factor

@Serializable

data class Factor(val strategy: String, val emailAddressId: String? = null, val phoneNumberId: String? = null, val web3WalletId: String? = null, val trustedDeviceId: String? = null, val enterpriseConnectionId: String? = null, val enterpriseConnectionName: String? = null, val safeIdentifier: String? = null, val primary: Boolean? = null, val default: Boolean? = null)

The Factor type represents the factor verification strategy that can be used in the sign-in process.

Constructors

constructor(strategy: String, emailAddressId: String? = null, phoneNumberId: String? = null, web3WalletId: String? = null, trustedDeviceId: String? = null, enterpriseConnectionId: String? = null, enterpriseConnectionName: String? = null, safeIdentifier: String? = null, primary: Boolean? = null, default: Boolean? = null)

Properties

@SerialName(value = "default")

val default: Boolean?

Whether the factor is the default second factor.

@SerialName(value = "email_address_id")

val emailAddressId: String?

The ID of the email address that a code or link will be sent to.

enterpriseConnectionId

@SerialName(value = "enterprise_connection_id")

val enterpriseConnectionId: String?

The ID of the enterprise connection that will be used for SSO.

enterpriseConnectionName

@SerialName(value = "enterprise_connection_name")

val enterpriseConnectionName: String?

The display name of the enterprise connection that will be used for SSO.

@SerialName(value = "phone_number_id")

val phoneNumberId: String?

The ID of the phone number that a code will be sent to.

val primary: Boolean?

Whether the factor is the primary factor.

@SerialName(value = "safe_identifier")

val safeIdentifier: String?

The safe identifier of the factor.

val strategy: String

The strategy of the factor.

trustedDeviceId

@SerialName(value = "trusted_device_id")

val trustedDeviceId: String?

The ID of the trusted-device credential that will be used to sign a challenge.

val web3WalletId: String?

The ID of the Web3 wallet that will be used to sign a message.

Functions

fun Factor.isResetFactor(): Boolean