mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
HLRC: Delete role API (#34620)
Adds the "Delete role" API to the high-level REST client.
This commit is contained in:
parent
adc3816e32
commit
9fb2f7cc20
10 changed files with 340 additions and 6 deletions
|
@ -10,7 +10,7 @@
|
|||
[id="{upid}-{api}-request"]
|
||||
==== Delete Request
|
||||
|
||||
A +{request}+ requires the following arguments:
|
||||
A +{request}+ has no arguments
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
|
|
33
docs/java-rest/high-level/security/delete-role.asciidoc
Normal file
33
docs/java-rest/high-level/security/delete-role.asciidoc
Normal file
|
@ -0,0 +1,33 @@
|
|||
--
|
||||
:api: delete-role
|
||||
:request: DeleteRoleRequest
|
||||
:response: DeleteRoleResponse
|
||||
--
|
||||
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete Role API
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Delete Role Request
|
||||
|
||||
A +{request}+ has a single argument
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> role to delete
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Delete Response
|
||||
|
||||
The returned +{response}+ allows to retrieve information about the executed
|
||||
operation as follows:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> whether the given role was found
|
|
@ -310,12 +310,16 @@ include::rollup/get_rollup_caps.asciidoc[]
|
|||
|
||||
== Security APIs
|
||||
|
||||
:upid: {mainid}-security
|
||||
:doc-tests-file: {doc-tests}/SecurityDocumentationIT.java
|
||||
|
||||
The Java High Level REST Client supports the following Security APIs:
|
||||
|
||||
* <<java-rest-high-security-put-user>>
|
||||
* <<java-rest-high-security-enable-user>>
|
||||
* <<java-rest-high-security-disable-user>>
|
||||
* <<java-rest-high-security-change-password>>
|
||||
* <<java-rest-high-security-delete-role>>
|
||||
* <<java-rest-high-security-get-certificates>>
|
||||
* <<java-rest-high-security-put-role-mapping>>
|
||||
* <<java-rest-high-security-delete-role-mapping>>
|
||||
|
@ -324,6 +328,7 @@ include::security/put-user.asciidoc[]
|
|||
include::security/enable-user.asciidoc[]
|
||||
include::security/disable-user.asciidoc[]
|
||||
include::security/change-password.asciidoc[]
|
||||
include::security/delete-role.asciidoc[]
|
||||
include::security/get-certificates.asciidoc[]
|
||||
include::security/put-role-mapping.asciidoc[]
|
||||
include::security/delete-role-mapping.asciidoc[]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue