Delete users Generally available

DELETE /_security/user/{username}
Api key auth Basic auth Bearer auth

Delete users from the native realm.

highlight#highlightFromAnchor" href="#topic-required-authorization"> Required authorization

  • Cluster privileges: manage_security

Path parameters

  • username string Required

    An identifier for the user.

Query parameters

  • 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.

Responses

  • 200 application/json
    details#setActive"> 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}
dropdown#toggle click@window->dropdown#hide touchend@window->dropdown#hide" data-dropdown-target="button" data-scrollable="false" data-headings="false" aria-expanded="false" aria-haspopup="true" role="menu" tabindex="0">
Console 
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
}