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_2b8lKxzUgn5M1hsjaTW1mcjc0iB';

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

console.log(response);
/*
_DeletedObject {
  object: 'user',
  id: 'user_2b8kQleSRNmcOSCdJ1Y8pSRr4mK',
  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 details.

Feedback

What did you think of this content?