github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 23:27:25 -04:00
Code Issues Projects Releases Packages Wiki Activity

HLREST: Add Clear Roles Cache API (#34187)

Browse source 
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
This commit is contained in:
Boaz Leskes 2018-10-26 20:16:44 +02:00 • committed by Jay Modi
parent fced5e826c
commit a086c665a3
9 changed files with 513 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/java-rest/high-level/security/clear-roles-cache.asciidoc Normal file
View file

@ -0,0 +1,32 @@
--
:api: clear-roles-cache
:request: ClearRolesCacheRequest
:response: ClearRolesCacheResponse
--
[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

2
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -322,6 +322,7 @@ The Java High Level REST Client supports the following Security APIs:
* <<java-rest-high-security-disable-user>>
* <<java-rest-high-security-change-password>>
* <<java-rest-high-security-delete-role>>
* <<{upid}-clear-roles-cache>>
* <<java-rest-high-security-get-certificates>>
* <<java-rest-high-security-put-role-mapping>>
* <<java-rest-high-security-delete-role-mapping>>
@ -331,6 +332,7 @@ include::security/enable-user.asciidoc[]
include::security/disable-user.asciidoc[]
include::security/change-password.asciidoc[]
include::security/delete-role.asciidoc[]
include::security/clear-roles-cache.asciidoc[]
include::security/get-certificates.asciidoc[]
include::security/put-role-mapping.asciidoc[]
include::security/delete-role-mapping.asciidoc[]