honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/security/clear-roles-cache.asciidoc

33 lines
957 B
Plaintext
Raw Normal View History

HLREST: Add Clear Roles Cache API (#34187) Adds support for the Clear Roles Cache API to the High Level Rest Client. As part of this a helper class, NodesResponseHeader, has been added that enables parsing the nodes header from responses that are node requests. Relates to #29827
2018-10-26 14:16:44 -04:00
--
:api: clear-roles-cache
:request: ClearRolesCacheRequest
:response: ClearRolesCacheResponse
--
[DOCS] Add missing icons to security HLRC APIs (#46619)
2019-09-11 16:19:13 -04:00
[role="xpack"]
HLREST: Add Clear Roles Cache API (#34187) Adds support for the Clear Roles Cache API to the High Level Rest Client. As part of this a helper class, NodesResponseHeader, has been added that enables parsing the nodes header from responses that are node requests. Relates to #29827
2018-10-26 14:16:44 -04:00
[id="{upid}-{api}"]
=== Clear Roles Cache API
[id="{upid}-{api}-request"]
==== Clear Roles Cache Request
A +{request}+ supports defining the name of roles 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