mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-04 01:49:15 +00:00
d7c5d8049a
* This commit is part of our plan to deprecate and ultimately remove the use of _xpack in the REST APIs. - REST API docs - HLRC docs and doc tests - Handle REST actions with deprecation warnings - Changed endpoints in rest-api-spec and relevant file names
40 lines
814 B
Plaintext
40 lines
814 B
Plaintext
[role="xpack"]
|
|
[[security-api-clear-role-cache]]
|
|
=== Clear roles cache API
|
|
|
|
Evicts roles from the native role cache.
|
|
|
|
==== Request
|
|
|
|
`POST /_security/role/<name>/_clear_cache`
|
|
|
|
==== Description
|
|
|
|
For more information about the native realm, see
|
|
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
|
|
|
|
==== Path Parameters
|
|
|
|
`name`::
|
|
(string) The name of the role.
|
|
|
|
|
|
//==== Request Body
|
|
|
|
==== 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`:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /_security/role/my_admin_role/_clear_cache
|
|
--------------------------------------------------
|
|
// CONSOLE
|