Get builtin privileges

GET /_security/privilege/_builtin

Auth

Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

Read the reference documentation

Required authorization

Cluster privileges manage_security

Response

application/json

cluster union anyOf[] required: The list of cluster privileges that are understood by this version of Elasticsearch.; Values: 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
index string[] required: The list of index privileges that are understood by this version of Elasticsearch.
remote_cluster enum[] required: The list of remote_cluster privileges that are understood by this version of Elasticsearch.; Values: monitor_enrich monitor_stats

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/privilege/_builtin

JavaScript Elasticsearch JavaScript Client

const response = await client.security.getBuiltinPrivileges();

Python Elasticsearch Python Client

resp = client.security.get_builtin_privileges()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/privilege/_builtin" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getBuiltinPrivileges();

C# Elasticsearch .NET Client

var response = await client.Security.GetBuiltinPrivilegesAsync();

PHP Elasticsearch PHP Client

$resp = $client->security()->getBuiltinPrivileges();

Ruby Elasticsearch Ruby Client

response = client.security.get_builtin_privileges

Response

A successful response from GET /_security/privilege/_builtin.

{
  "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_connector",
    "manage_data_frame_transforms",
    "manage_data_stream_global_retention",
    "manage_enrich",
    "manage_ilm",
    "manage_index_templates",
    "manage_inference",
    "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_connector",
    "monitor_data_frame_transforms",
    "monitor_data_stream_global_retention",
    "monitor_enrich",
    "monitor_inference",
    "monitor_ml",
    "monitor_rollup",
    "monitor_snapshot",
    "monitor_stats",
    "monitor_text_structure",
    "monitor_transform",
    "monitor_watcher",
    "none",
    "post_behavioral_analytics_event",
    "read_ccr",
    "read_connector_secrets",
    "read_fleet_secrets",
    "read_ilm",
    "read_pipeline",
    "read_security",
    "read_slm",
    "transport_client",
    "write_connector_secrets",
    "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"
  ],
  "remote_cluster" : [
    "monitor_enrich",
    "monitor_stats"
  ]
}