組み込み特権API

このElasticsearchのバージョンで利用可能なクラスター特権とインデックス特権のリストを取得します。

リクエスト

GET /_security/privilege/_builtin

前提条件

  • このAPIを使用するには、read_securityクラスター特権（またはmanage_securityやallなどのより高い特権）が必要です。

説明

このAPIは、クエリされているElasticsearchのバージョンで利用可能なクラスターおよびインデックス特権名のセットを取得します。

特定の特権をユーザーが持っているかどうかを確認するには、特権確認APIを使用します。

レスポンスボディ

レスポンスは2つのフィールドを持つオブジェクトです：

  • cluster
  • （文字列の配列）このElasticsearchのバージョンで理解されるクラスター特権のリスト。
  • index
  • （文字列の配列）このElasticsearchのバージョンで理解されるインデックス特権のリスト。
  • remote_cluster
  • （文字列の配列）このElasticsearchのバージョンで理解されるremote_cluster特権のリスト。

例

以下の例は、すべての組み込み特権の名前を取得します:

Python

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

Js

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

コンソール

  1. GET /_security/privilege/_builtin

成功した呼び出しは、”cluster”、”index”、および”remote_cluster”フィールドを持つオブジェクトを返します。

コンソール-結果

  1. {
  2.   "cluster" : [
  3.    "all",
  4.    "cancel_task",
  5.    "create_snapshot",
  6.    "cross_cluster_replication",
  7.    "cross_cluster_search",
  8.    "delegate_pki",
  9.    "grant_api_key",
  10.    "manage",
  11.    "manage_api_key",
  12.    "manage_autoscaling",
  13.    "manage_behavioral_analytics",
  14.    "manage_ccr",
  15.    "manage_connector",
  16.    "manage_data_frame_transforms",
  17.    "manage_data_stream_global_retention",
  18.    "manage_enrich",
  19.    "manage_ilm",
  20.    "manage_index_templates",
  21.    "manage_inference",
  22.    "manage_ingest_pipelines",
  23.    "manage_logstash_pipelines",
  24.    "manage_ml",
  25.    "manage_oidc",
  26.    "manage_own_api_key",
  27.    "manage_pipeline",
  28.    "manage_rollup",
  29.    "manage_saml",
  30.    "manage_search_application",
  31.    "manage_search_query_rules",
  32.    "manage_search_synonyms",
  33.    "manage_security",
  34.    "manage_service_account",
  35.    "manage_slm",
  36.    "manage_token",
  37.    "manage_transform",
  38.    "manage_user_profile",
  39.    "manage_watcher",
  40.    "monitor",
  41.    "monitor_connector",
  42.    "monitor_data_frame_transforms",
  43.    "monitor_data_stream_global_retention",
  44.    "monitor_enrich",
  45.    "monitor_inference",
  46.    "monitor_ml",
  47.    "monitor_rollup",
  48.    "monitor_snapshot",
  49.    "monitor_text_structure",
  50.    "monitor_transform",
  51.    "monitor_watcher",
  52.    "none",
  53.    "post_behavioral_analytics_event",
  54.    "read_ccr",
  55.    "read_connector_secrets",
  56.    "read_fleet_secrets",
  57.    "read_ilm",
  58.    "read_pipeline",
  59.    "read_security",
  60.    "read_slm",
  61.    "transport_client",
  62.    "write_connector_secrets",
  63.    "write_fleet_secrets"
  64.   ],
  65.   "index" : [
  66.    "all",
  67.    "auto_configure",
  68.    "create",
  69.    "create_doc",
  70.    "create_index",
  71.    "cross_cluster_replication",
  72.    "cross_cluster_replication_internal",
  73.    "delete",
  74.    "delete_index",
  75.    "index",
  76.    "maintenance",
  77.    "manage",
  78.    "manage_data_stream_lifecycle",
  79.    "manage_follow_index",
  80.    "manage_ilm",
  81.    "manage_leader_index",
  82.    "monitor",
  83.    "none",
  84.    "read",
  85.    "read_cross_cluster",
  86.    "view_index_metadata",
  87.    "write"
  88.   ],
  89.   "remote_cluster" : [
  90.    "monitor_enrich"
  91.   ]
  92. }