get-builtin-privileges.asciidoc 721 B

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