Yannick Welsch 9fb2f7cc20
HLRC: Delete role API (#34620)
Adds the "Delete role" API to the high-level REST client.
2018-10-20 12:11:36 +02:00

34 lines
862 B
Plaintext

--
: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