Clear the roles cache

Evict roles from the native role cache.

Required authorization

name union Name | [] Name required: A comma-separated list of roles to evict from the role cache. To evict all roles, use an asterisk (*). It does not support other wildcard patterns.

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_security/role/my_admin_role/_clear_cache

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.security().clearCachedRoles(c -> c
    .name("my_admin_role")
);

C# Elasticsearch .NET Client

var response = await client.Security.ClearCachedRolesAsync(name: new[] { "my_admin_role" });

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

No example