43 lines
1.1 KiB
Plaintext
43 lines
1.1 KiB
Plaintext
[role="xpack"]
|
|
[[security-api-clear-role-cache]]
|
|
=== Clear roles cache API
|
|
++++
|
|
<titleabbrev>Clear roles cache</titleabbrev>
|
|
++++
|
|
|
|
Evicts roles from the native role cache.
|
|
|
|
[[security-api-clear-role-cache-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_security/role/<name>/_clear_cache`
|
|
|
|
[[security-api-clear-role-cache-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* To use this API, you must have at least the `manage_security` cluster
|
|
privilege.
|
|
|
|
[[security-api-clear-role-cache-desc]]
|
|
==== {api-description-title}
|
|
|
|
For more information about the native realm, see
|
|
<<realms>> and <<configuring-native-realm>>.
|
|
|
|
[[security-api-clear-role-cache-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`name`::
|
|
(string) The name of the role.
|
|
|
|
[[security-api-clear-role-cache-example]]
|
|
==== {api-examples-title}
|
|
|
|
The clear roles cache API evicts roles from the native role cache. For example,
|
|
to clear the cache for `my_admin_role`:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_security/role/my_admin_role/_clear_cache
|
|
--------------------------------------------------
|