elasticsearch/docs/java-rest/high-level/security/get-builtin-privileges.asciidoc
Tim Vernum 539a1202b7
Support builtin privileges in get privileges API (#42134)
Adds a new "/_security/privilege/_builtin" endpoint so that builtin
index and cluster privileges can be retrieved via the Rest API

Resolves: #29771
2019-07-03 15:55:50 +10:00

27 lines
721 B
Text

--
:api: get-builtin-privileges
:request: GetBuiltinPrivilegesRequest
:response: GetBuiltinPrivilegesResponse
--
[id="{upid}-{api}"]
=== Get Builtin Privileges API
include::../execution-no-req.asciidoc[]
[id="{upid}-{api}-response"]
==== Get Builtin Privileges Response
The returned +{response}+ contains the following properties
`clusterPrivileges`::
A `Set` of all _cluster_ privileges that are understood by this node.
`indexPrivileges`::
A `Set` of all _index_ privileges that are understood by this node.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------