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 »

› › ›

Delete users API

edit

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

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 »