Delete roles

DELETE /_security/role/{name}

Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files.

Required authorization

Cluster privileges: manage_security

Path Parameters

name string Name required: The name of the role.

Query Parameters

refresh enum Refresh: 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

Response

application/json

Examples

A successful response from DELETE /_security/role/my_admin_role. If the role is successfully deleted, found is set to true.

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE /_security/role/my_admin_role

JavaScript Elasticsearch JavaScript Client

const response = await client.security.deleteRole({
  name: "my_admin_role",
});

Python Elasticsearch Python Client

resp = client.security.delete_role(
    name="my_admin_role",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_security/role/my_admin_role" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().deleteRole(d -> d
    .name("my_admin_role")
);

C# Elasticsearch .NET Client

var response = await client.Security.DeleteRoleAsync(name: "my_admin_role");

PHP Elasticsearch PHP Client

$resp = $client->security()->deleteRole([
    "name" => "my_admin_role",
]);

Ruby Elasticsearch Ruby Client

response = client.security.delete_role(
  name: "my_admin_role"
)

Response

{
  "found" : true
}