get-builtin-privileges.asciidoc 735 B

123456789101112131415161718192021222324252627
  1. --
  2. :api: get-builtin-privileges
  3. :request: GetBuiltinPrivilegesRequest
  4. :response: GetBuiltinPrivilegesResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Get Builtin Privileges API
  9. include::../execution-no-req.asciidoc[]
  10. [id="{upid}-{api}-response"]
  11. ==== Get Builtin Privileges Response
  12. The returned +{response}+ contains the following properties
  13. `clusterPrivileges`::
  14. A `Set` of all _cluster_ privileges that are understood by this node.
  15. `indexPrivileges`::
  16. A `Set` of all _index_ privileges that are understood by this node.
  17. ["source","java",subs="attributes,callouts,macros"]
  18. --------------------------------------------------
  19. include-tagged::{doc-tests-file}[{api}-response]
  20. --------------------------------------------------