原英文版地址: https://www.elastic.co/guide/en/elasticsearch/reference/7.7/security-api-get-builtin-privileges.html, 原文档版权归 www.elastic.co 所有
本地英文版地址: ../en/security-api-get-builtin-privileges.html
本地英文版地址: ../en/security-api-get-builtin-privileges.html
重要: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 当前版本文档。
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
manage_security
cluster privilege (or a greater privilege such asall
).
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", "create_snapshot", "delegate_pki", "grant_api_key", "manage", "manage_api_key", "manage_autoscaling", "manage_ccr", "manage_data_frame_transforms", "manage_enrich", "manage_ilm", "manage_index_templates", "manage_ingest_pipelines", "manage_ml", "manage_oidc", "manage_own_api_key", "manage_pipeline", "manage_rollup", "manage_saml", "manage_security", "manage_slm", "manage_token", "manage_transform", "manage_watcher", "monitor", "monitor_data_frame_transforms", "monitor_ml", "monitor_rollup", "monitor_snapshot", "monitor_transform", "monitor_watcher", "none", "read_ccr", "read_ilm", "read_slm", "transport_client" ], "index" : [ "all", "create", "create_doc", "create_index", "delete", "delete_index", "index", "maintenance", "manage", "manage_follow_index", "manage_ilm", "manage_leader_index", "monitor", "none", "read", "read_cross_cluster", "view_index_metadata", "write" ] }