Delete role mappings

DELETE /_security/role_mapping/{name}

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The delete role mappings API cannot remove role mappings that are defined in role mapping files.

Required authorization

Cluster privileges: manage_security

About mapping users to roles

Path Parameters

name string Name required: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.

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_mapping/mapping1. If the mapping is successfully deleted, found is true.

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE /_security/role_mapping/mapping1

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.security.delete_role_mapping(
    name="mapping1",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_security/role_mapping/mapping1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().deleteRoleMapping(d -> d
    .name("mapping1")
);

C# Elasticsearch .NET Client

var response = await client.Security.DeleteRoleMappingAsync(name: "mapping1");

PHP Elasticsearch PHP Client

$resp = $client->security()->deleteRoleMapping([
    "name" => "mapping1",
]);

Ruby Elasticsearch Ruby Client

response = client.security.delete_role_mapping(
  name: "mapping1"
)

Response

{
  "found" : true
}