Docs

deleteUser()

Deletes a User given a valid ID.

function deleteUser(userId: string): Promise<User>
  • Name
    userId
    Type
    string
    Description

    The ID of the user to delete.

const userId = 'user_123'

const response = await clerkClient.users.deleteUser(userId)

console.log(response)
/*
_DeletedObject {
  object: 'user',
  id: 'user_123',
  slug: null,
  deleted: true
}
*/

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on