Skip to main content
Docs

deleteUserPasskey()

Deletes the passkey identification for a given user and notifies them through email. Returns a .

function deleteUserPasskey(params: DeleteUserPasskeyParams): Promise<DeletedObject>

DeleteUserPasskeyParams

  • Name
    userId
    Type
    string
    Description

    The ID of the user that owns the passkey identity.

  • Name
    passkeyIdentificationId
    Type
    string
    Description

    The ID of the passkey identity to be deleted.

Example

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const userId = 'user_123'
const passkeyIdentificationId = 'passkey_identification_123'

const response = await clerkClient.users.deleteUserPasskey({
  userId,
  passkeyIdentificationId,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/users/{user_id}/passkeys/{passkey_identification_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on