delete-user.asciidoc 840 B

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