This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Clear cache API Clear privileges cache API »

› › ›

Clear roles cache API

edit

Clear roles cache API

edit

Evicts roles from the native role cache.

Request

edit

POST /_security/role/<roles>/_clear_cache

Prerequisites

edit

To use this API, you must have at least the manage_security cluster privilege.

Description

edit

For more information about the native realm, see Realms and Native user authentication.

Path parameters

edit

<roles>: (Required, string) Comma-separated list of roles to evict from the role cache. To evict all roles, use *. Does not support other wildcard patterns.

Examples

edit

The clear roles cache API evicts roles from the native role cache. For example, to clear the cache for my_admin_role:

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

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

POST /_security/role/my_admin_role/_clear_cache

Specify multiple roles as a comma-separated list.

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

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

POST /_security/role/my_admin_role,my_test_role/_clear_cache

To clear all roles from the cache, use *.

resp = client.security.clear_cached_roles(
    name="*",
)
print(resp)

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

POST /_security/role/*/_clear_cache

« Clear cache API Clear privileges cache API »