mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-08 14:05:27 +00:00
6f6b265166
This change adds support for clearing the cache of a realm. The realms cache may contain a stale set of credentials or incorrect role assignment, which can be corrected by clearing the cache of the entire realm or just that of a specific user. Relates #29827
34 lines
958 B
Plaintext
34 lines
958 B
Plaintext
|
|
--
|
|
:api: clear-realm-cache
|
|
:request: ClearRealmCacheRequest
|
|
:response: ClearRealmCacheResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Clear Realm Cache API
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Clear Realm Cache Request
|
|
|
|
A +{request}+ supports defining the name of realms and usernames that the cache should be cleared
|
|
for.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Clear Roles Cache Response
|
|
|
|
The returned +{response}+ allows to retrieve information about where the cache was cleared.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> the list of nodes that the cache was cleared on
|