Clear roles cache API

Evicts roles from the native role cache.

Request

POST /_security/role/<name>/_clear_cache

Prerequisites

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

Description

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

Path parameters

name
(string) The name of the role.

Examples

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