JavaScript: deleteUser

Delete a user. Requires a service_role key. Returns the user that was deleted. In cases of concurrent updates, the user object returned might not accurately reflect the user information at the time of deletion.

Parameters

• id

  (Required)

  The user id you want to remove.

• shouldSoftDelete

  (Required)

  If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible. Defaults to false for backward compatibility. This function should only be called on a server. Never expose your `service_role` key in the browser.

Examples

Removes a user

const { data, error } = await supabase.auth.admin.deleteUser(
  '715ed5db-f090-4b8c-a067-640ecee36aa0'
)