Skip to main content

deleteUserTOTP()

Deletes all of the TOTP secrets for the given user.

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

Parameters

  • Name
    userId
    Type
    string
    Description

    The ID of the user to delete the TOTP secrets for.

Tip

This method removes the user's authenticator app enrollment. If the user has no other second factor enrolled, Clerk also deletes their backup codes and disables MFA. To remove every MFA method at once, use disableUserMFA(). See MFA account recovery.

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.deleteUserTOTP(userId)

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub