IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create or update role mappings API Create or update roles API »
Elastic Docs ›Elasticsearch Guide [6.3] ›X-Pack APIs ›Security APIs

Clear roles cache API

edit

Clear roles cache API

edit

Evicts roles from the native role cache.

Request

edit

POST /_xpack/security/role/<name>/_clear_cache

Description

edit

For more information about the native realm, see Realms and Configuring a native realm.

Path Parameters

edit
name
(string) The name of the role.

Authorization

edit

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

Examples

edit

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

POST /_xpack/security/role/my_admin_role/_clear_cache
« Create or update role mappings API Create or update roles API »