Clerk Android/com.clerk.passkeys/Passkey

Passkey

@Serializable

data class Passkey(val id: String, val name: String, val verification: Verification? = null, val createdAt: Long, val updatedAt: Long, val lastUsedAt: Long? = null)

An object that represents a passkey associated with a user.

Passkeys are a modern, secure authentication method that uses cryptographic key pairs to authenticate users without requiring passwords. They provide a phishing-resistant authentication experience using biometrics, device PINs, or other local authentication methods.

Constructors

constructor(id: String, name: String, verification: Verification? = null, createdAt: Long, updatedAt: Long, lastUsedAt: Long? = null)

Types

object Companion

Properties

val createdAt: Long

The date when the passkey was created.

The unique identifier of the passkey.

val lastUsedAt: Long? = null

The date when the passkey was last used.

val name: String

The passkey's name.

val updatedAt: Long

The date when the passkey was last updated.

val verification: Verification? = null

The verification details for the passkey.

Functions

attemptVerification

suspend fun Passkey.attemptVerification(publicKeyCredential: String): ClerkResult<Passkey, ClerkErrorResponse>

Attempts to verify this passkey using the provided public key credential.

suspend fun Passkey.delete(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes this passkey from the user's account.

suspend fun Passkey.update(name: String? = null): ClerkResult<Passkey, ClerkErrorResponse>

Updates the properties of this passkey.