IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Clear roles cache APIedit
Evicts roles from the native role cache.
Requestedit
POST /_security/role/<roles>/_clear_cache
Prerequisitesedit
-
To use this API, you must have at least the
manage_security
cluster privilege.
Descriptionedit
For more information about the native realm, see Realms and Native user authentication.
Path parametersedit
-
<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.
Examplesedit
The clear roles cache API evicts roles from the native role cache. For example,
to clear the cache for my_admin_role
:
POST /_security/role/my_admin_role/_clear_cache
Specify multiple roles as a comma-separated list.
POST /_security/role/my_admin_role,my_test_role/_clear_cache
To clear all roles from the cache, use *
.
POST /_security/role/*/_clear_cache