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

BiometricCredential

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

Biometric-credential strategy for authentication using a locally enrolled biometric credential.

Constructors

BiometricCredential

constructor(id: String? = null, identifierHint: String? = null, promptTitle: String? = null, promptSubtitle: String? = null, strategy: String = TRUSTED_DEVICE)

Properties

val id: String?

The biometric credential ID to use. When omitted, the available local credential is used.

identifierHint

val identifierHint: String?

A local-only user identifier hint used to choose a matching credential.

promptSubtitle

val promptSubtitle: String?

The subtitle shown in the system authentication prompt.

promptTitle

val promptTitle: String?

The title shown in the system authentication prompt.

strategy

open override val strategy: String

The authentication strategy identifier.