IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get builtin privileges API
editGet builtin privileges API
editRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
Request
editGET /_security/privilege/_builtin
Prerequisites
edit-
To use this API, you must have - the
manage_securitycluster privilege (or a greater privilege such asall).
Description
editThis API retrieves the set of cluster and index privilege names that are available in the version of Elasticsearch that is being queried.
To check whether a user has particular privileges, use the has privileges API.
Response body
editThe response is an object with two fields:
-
cluster - (array of string) The list of cluster privileges that are understood by this version of Elasticsearch.
-
index - (array of string) The list of index privileges that are understood by this version of Elasticsearch.
Examples
editThe following example retrieves the names of all builtin privileges:
GET /_security/privilege/_builtin
A successful call returns an object with "cluster" and "index" fields.
{
"cluster" : [
"all",
"create_snapshot",
"manage",
"manage_api_key",
"manage_ccr",
"manage_data_frame_transforms",
"manage_ilm",
"manage_index_templates",
"manage_ingest_pipelines",
"manage_ml",
"manage_oidc",
"manage_pipeline",
"manage_rollup",
"manage_saml",
"manage_security",
"manage_token",
"manage_watcher",
"monitor",
"monitor_data_frame_transforms",
"monitor_ml",
"monitor_rollup",
"monitor_watcher",
"none",
"read_ccr",
"read_ilm",
"transport_client"
],
"index" : [
"all",
"create",
"create_index",
"delete",
"delete_index",
"index",
"manage",
"manage_follow_index",
"manage_ilm",
"manage_leader_index",
"monitor",
"none",
"read",
"read_cross_cluster",
"view_index_metadata",
"write"
]
}