Get builtin privileges APIedit
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
Requestedit
GET /_security/privilege/_builtin
Prerequisitesedit
-
To use this API, you must have the
read_securitycluster privilege (or a greater privilege such asmanage_securityorall).
Descriptionedit
This 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 bodyedit
The 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.
Examplesedit
The 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",
"cancel_task",
"create_snapshot",
"cross_cluster_replication",
"cross_cluster_search",
"delegate_pki",
"grant_api_key",
"manage",
"manage_api_key",
"manage_autoscaling",
"manage_behavioral_analytics",
"manage_ccr",
"manage_data_frame_transforms",
"manage_enrich",
"manage_ilm",
"manage_index_templates",
"manage_ingest_pipelines",
"manage_logstash_pipelines",
"manage_ml",
"manage_oidc",
"manage_own_api_key",
"manage_pipeline",
"manage_rollup",
"manage_saml",
"manage_search_application",
"manage_search_query_rules",
"manage_search_synonyms",
"manage_security",
"manage_service_account",
"manage_slm",
"manage_token",
"manage_transform",
"manage_user_profile",
"manage_watcher",
"monitor",
"monitor_data_frame_transforms",
"monitor_ml",
"monitor_rollup",
"monitor_snapshot",
"monitor_text_structure",
"monitor_transform",
"monitor_watcher",
"none",
"post_behavioral_analytics_event",
"read_ccr",
"read_fleet_secrets",
"read_ilm",
"read_pipeline",
"read_security",
"read_slm",
"transport_client",
"write_fleet_secrets"
],
"index" : [
"all",
"auto_configure",
"create",
"create_doc",
"create_index",
"cross_cluster_replication",
"cross_cluster_replication_internal",
"delete",
"delete_index",
"index",
"maintenance",
"manage",
"manage_data_stream_lifecycle",
"manage_follow_index",
"manage_ilm",
"manage_leader_index",
"monitor",
"none",
"read",
"read_cross_cluster",
"view_index_metadata",
"write"
]
}