› › ›

API получения встроенных привилегий

Получает список кластерных привилегий и привилегий к индексам, доступных в этой версии Elasticsearch.

Запрос

GET /_security/privilege/_builtin

Предварительные условия

Для использования этого API необходимо иметь привилегию read_security кластера (или более широкую привилегию, такую как manage_security или all).

Описание

Этот API получает набор имен привилегий кластера и индекса, доступных в версии Elasticsearch, к которой осуществляется запрос.

Для проверки наличия определенных привилегий у пользователя воспользуйтесь API проверки наличия привилегий.

Тело ответа

Ответ представляет собой объект с двумя полями:

cluster: (массив строк) Список кластерных привилегий, поддерживаемых этой версией Elasticsearch.
index: (массив строк) Список привилегий к индексам, поддерживаемых этой версией Elasticsearch.
remote_cluster: (массив строк) Список привилегий remote_cluster, поддерживаемых этой версией Elasticsearch.

Примеры

В следующем примере извлекаются имена всех встроенных привилегий:

resp = client.security.get_builtin_privileges()
print(resp)

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

GET /_security/privilege/_builtin

Успешный вызов возвращает объект с полями "cluster", "index" и "remote_cluster".

{
  "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"
  ]
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-builtin-privileges.html