New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete service account tokens API Disable users API »
Elastic Docs ›Elasticsearch Guide [8.16] ›REST APIs ›Security APIs

Delete users API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Delete users API

edit

Deletes users from the native realm.

Request

edit

DELETE /_security/user/<username>

Prerequisites

edit
  • To use this API, you must have at least the manage_security cluster privilege.

Description

edit

For more information about the native realm, see Realms and Native user authentication.

Path parameters

edit
username
(Required, string) An identifier for the user.

Examples

edit

The following example deletes the user jacknich:

resp = client.security.delete_user(
    username="jacknich",
)
print(resp)
const response = await client.security.deleteUser({
  username: "jacknich",
});
console.log(response);
DELETE /_security/user/jacknich
Copy as curlTry in Elastic 

If the user is successfully deleted, the request returns {"found": true}. Otherwise, found is set to false.

{
  "found" : true
}
« Delete service account tokens API Disable users API »
Was this helpful?
Feedback