Docs
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Reference [6.5] » X-Pack APIs » Security APIs » Clear roles cache API
« Clear cache API Create or update application privileges API »

Clear roles cache API

Evicts roles from the native role cache.

Request

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

Description

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

Path Parameters

name
(string) The name of the role.

Authorization

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

Examples

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
« Clear cache API Create or update application privileges API »