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

Strategy

sealed interface Strategy

A sealed interface defining different strategies for creating a sign-in.

Each implementation represents a different method of initiating the sign-in process.

Inheritors

EmailCode

PhoneCode

Password

ResetPasswordEmailCode

ResetPasswordPhoneCode

Types

EmailCode

@Serializable

data class EmailCode(val identifier: String, val strategy: String = EMAIL_CODE) : SignIn.CreateParams.Strategy

Email code sign-in strategy.

Identifier

@Serializable

data class Identifier(val strategy: String? = null, val identifier: String, val password: String? = null) : SignIn.CreateParams.Strategy

Passkey

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

Passkey strategy for authentication using a passkey.

Password

@Serializable

data class Password(val identifier: String, val password: String, val strategy: String = PASSWORD) : SignIn.CreateParams.Strategy

Password sign-in strategy.

PhoneCode

@Serializable

data class PhoneCode(val identifier: String, val strategy: String = PHONE_CODE) : SignIn.CreateParams.Strategy

Phone code sign-in strategy.

ResetPasswordEmailCode

@Serializable

data class ResetPasswordEmailCode(val identifier: String, val strategy: String = RESET_PASSWORD_EMAIL_CODE) : SignIn.CreateParams.Strategy

ResetPasswordPhoneCode

@Serializable

data class ResetPasswordPhoneCode(val identifier: String, val strategy: String = RESET_PASSWORD_PHONE_CODE) : SignIn.CreateParams.Strategy

Ticket

@Serializable

data class Ticket(val ticket: String, val strategy: String = TICKET) : SignIn.CreateParams.Strategy

Ticket strategy for authentication using a ticket.

Transfer

data class Transfer(val strategy: String = TRANSFER) : SignIn.CreateParams.Strategy

Transfer strategy for account transfer scenarios.

TrustedDevice

data class TrustedDevice(val id: String? = null, val identifierHint: String? = null, val promptTitle: String? = null, val promptSubtitle: String? = null, val strategy: String = TRUSTED_DEVICE) : SignIn.CreateParams.Strategy

Trusted-device strategy for authentication using a locally enrolled biometric credential.

Properties

strategy

abstract val strategy: String?

The authentication strategy identifier.