Skip to main content

deleteUserPasskey()

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

Returns the DeletedObject object.

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

DeleteUserPasskeyParams

  • Name
    passkeyIdentificationId
    Type
    string
    Description

    The ID of the passkey identification to delete.

  • Name
    userId
    Type
    string
    Description

    The ID of the user to delete the passkey for.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the 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?

Last updated on

GitHubEdit on GitHub