Bulk delete roles

DELETE /_security/role

Auth

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

Required privileges

Cluster privileges manage_security

Query parameters

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

Request body

names string[] required: An array of role names to delete

Response

application/json

deleted string[]: Array of deleted roles
not_found string[]: Array of roles that could not be found
errors object: Present if any deletes resulted in errors

Examples

Request Console 1 / 8 languages

Run DELETE /_security/roleto deletemy_admin_roleandmy_user_role` roles.

Console Kibana Dev Tools

DELETE /_security/role
{
  "names": ["my_admin_role", "my_user_role"]
}

JavaScript Elasticsearch JavaScript Client

const response = await client.security.bulkDeleteRole({
  names: ["my_admin_role", "my_user_role"],
});

Python Elasticsearch Python Client

resp = client.security.bulk_delete_role(
    names=[
        "my_admin_role",
        "my_user_role"
    ],
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_security/role" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "names": [
      "my_admin_role",
      "my_user_role"
    ]
  }'

Java Elasticsearch Java Client

client.security().bulkDeleteRole(b -> b
    .names(List.of("my_admin_role","my_user_role"))
);

C# Elasticsearch .NET Client

var response = await client.Security
    .BulkDeleteRoleAsync(d1 => d1
        .Names("my_admin_role", "my_user_role")
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->bulkDeleteRole([
    "body" => [
        "names" => array(
            "my_admin_role",
            "my_user_role",
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.security.bulk_delete_role(
  body: {
    "names": [
      "my_admin_role",
      "my_user_role"
    ]
  }
)

Response

A successful response from DELETE /_security/role.

{
  "deleted": [
      "my_admin_role",
      "my_user_role"
  ]
}

Required privileges

Query parameters

Request body { }

Response

Request body