IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Clear cache API Clear privileges cache API »
Elastic Docs ›Elasticsearch Guide [7.10] ›REST APIs ›Security APIs

Clear roles cache API

edit

Clear roles cache API

edit

Evicts roles from the native role cache.

Request

edit

POST /_security/role/<name>/_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
name
(string) The name of the role.

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 /_security/role/my_admin_role/_clear_cache
« Clear cache API Clear privileges cache API »