get-privileges.asciidoc 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. --
  2. :api: get-privileges
  3. :request: GetPrivilegesRequest
  4. :response: GetPrivilegesResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Get Privileges API
  8. [id="{upid}-{api}-request"]
  9. ==== Get Privileges Request
  10. The +{request}+ supports getting privilege(s) for all or for specific applications.
  11. ===== Specific privilege of a specific application
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. ===== All privileges of a specific application
  17. ["source","java",subs="attributes,callouts,macros"]
  18. --------------------------------------------------
  19. include-tagged::{doc-tests-file}[get-all-application-privileges-request]
  20. --------------------------------------------------
  21. ===== All privileges of all applications
  22. ["source","java",subs="attributes,callouts,macros"]
  23. --------------------------------------------------
  24. include-tagged::{doc-tests-file}[get-all-privileges-request]
  25. --------------------------------------------------
  26. include::../execution.asciidoc[]
  27. [id="{upid}-{api}-response"]
  28. ==== Get Privileges Response
  29. The returned +{response}+ allows to get information about the retrieved privileges as follows.
  30. ["source","java",subs="attributes,callouts,macros"]
  31. --------------------------------------------------
  32. include-tagged::{doc-tests-file}[{api}-response]
  33. --------------------------------------------------