Skip to main content

deleteUserBackupCodes()

Deletes all backup codes for the given user.

function deleteUserBackupCodes(userId: string): Promise<UserID>

Parameters

  • Name
    userId
    Type
    string
    Description

    The ID of the user to delete backup codes for.

Tip

This method deletes the user's backup codes without issuing new ones. If they lose their remaining second factor, they'll need an MFA reset unless they have an enrolled passkey and the instance has Passkeys satisfy multi-factor authentication enabled.

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 response = await clerkClient.users.deleteUserBackupCodes(userId)

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub