Delete users

Auth

Delete users from the native realm.

Required privileges

refresh enum: 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: true false wait_for

application/json

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

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE /_security/user/jacknich

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

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

C# Elasticsearch .NET Client

var response = await client.Security.DeleteUserAsync(username: "jacknich");

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

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

{
  "found" : true
}