delete-role.asciidoc 876 B

123456789101112131415161718192021222324252627282930313233
  1. --
  2. :api: delete-role
  3. :request: DeleteRoleRequest
  4. :response: DeleteRoleResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete Role API
  9. [id="{upid}-{api}-request"]
  10. ==== Delete Role Request
  11. A +{request}+ has a single argument
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. <1> role to delete
  17. include::../execution.asciidoc[]
  18. [id="{upid}-{api}-response"]
  19. ==== Delete Response
  20. The returned +{response}+ allows to retrieve information about the executed
  21. operation as follows:
  22. ["source","java",subs="attributes,callouts,macros"]
  23. --------------------------------------------------
  24. include-tagged::{doc-tests-file}[{api}-response]
  25. --------------------------------------------------
  26. <1> whether the given role was found