delete-user.asciidoc 854 B

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