Delete users | Elasticsearch API documentation (v8)

Delete users Generally available

DELETE /_security/user/{username}

Delete users from the native realm.

refresh string

If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

Values are true, false, or wait_for.

200 application/json
Hide response attribute Show response attribute object
- found boolean Required
  
  If the user is successfully deleted, the request returns {"found": true}. Otherwise, found is set to false.

DELETE /_security/user/{username}

DELETE /_security/user/jacknich

resp = client.security.delete_user(
    username="jacknich",
)

const response = await client.security.deleteUser({
  username: "jacknich",
});

response = client.security.delete_user(
  username: "jacknich"
)

$resp = $client->security()->deleteUser([
    "username" => "jacknich",
]);

curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_security/user/jacknich"

client.security().deleteUser(d -> d
    .username("jacknich")
);

Response examples (200)

A successful response from `DELETE /_security/user/jacknich`.

{
  "found" : true
}