クロスクラスタAPIキーの更新（Update Cross-Cluster API key）

クロスクラスターAPIキーAPIの更新

クロスクラスターAPIキーを更新します。このAPIキーは、APIキーに基づくリモートクラスターへのアクセスに使用されます。

リクエスト

PUT /_security/cross_cluster/api_key/<id>

前提条件

• このAPIを使用するには、少なくともmanage_securityクラスター権限を持っている必要があります。ユーザーは自分が作成したAPIキーのみを更新できます。他のユーザーのAPIキーを更新するには、run_as機能を使用して、他のユーザーの代理としてリクエストを送信してください。

このAPIの認証資格情報としてAPIキーを使用することはできません。APIキーを更新するには、所有者ユーザーの資格情報が必要です。

説明

このAPIを使用して、クロスクラスターAPIキー作成APIによって作成されたクロスクラスターAPIキーを更新します。期限切れのAPIキーや、APIキーを無効化するによって無効化されたAPIキーを更新することはできません。

このAPIは、APIキーのアクセス範囲、メタデータ、および有効期限の更新をサポートします。所有者ユーザーの情報（例：username、realm）も、毎回の呼び出しで自動的に更新されます。

このAPIは、REST APIキーを更新することはできません。これらは、APIキーの更新またはAPIキーの一括更新APIによって更新する必要があります。

パスパラメータ

• id
• （必須、文字列）更新するAPIキーのID。

リクエストボディ

リクエストボディに次のパラメータを指定できます。パラメータはオプションですが、すべてが欠落することはできません。

• access
• （オプション、オブジェクト）このAPIキーに付与されるアクセス権。アクセス権は、クロスクラスター検索およびクロスクラスターレプリケーションの権限で構成されます。少なくとも1つは指定する必要があります。指定された場合、新しいアクセス割り当ては以前に割り当てられたアクセスを完全に置き換えます。クロスクラスターAPIキーの作成APIの同じパラメータのフィールド構造を参照してください。
• metadata
• （オプション、オブジェクト）APIキーに関連付けたい任意のメタデータ。ネストされたデータ構造をサポートしています。metadataオブジェクト内では、_で始まるトップレベルキーはシステム使用のために予約されています。指定された場合、これは以前にAPIキーに関連付けられたメタデータを完全に置き換えます。
• expiration
• （オプション、文字列）APIキーの有効期限。デフォルトでは、APIキーは期限切れになりません。変更しない場合は省略できます。

レスポンスボディ

• updated
• （boolean）trueの場合、APIキーが更新されました。falseの場合、変更が検出されなかったため、APIキーは変更されませんでした。

例

次のようにクロスクラスターAPIキーを作成した場合:

Python

resp = client.perform_request(
   "POST",
   "/_security/cross_cluster/api_key",
   headers={"Content-Type": "application/json"},
   body={
   "name": "my-cross-cluster-api-key",
   "access": {
   "search": [
   {
   "names": [
   "logs*"
   ]
   }
   ]
   },
   "metadata": {
   "application": "search"
   }
   },
)
print(resp)

Js

const response = await client.transport.request({
  method: "POST",
  path: "/_security/cross_cluster/api_key",
  body: {
   name: "my-cross-cluster-api-key",
   access: {
   search: [
   {
   names: ["logs*"],
   },
   ],
   },
   metadata: {
   application: "search",
   },
  },
});
console.log(response);

コンソール

POST /_security/cross_cluster/api_key
{
  "name": "my-cross-cluster-api-key",
  "access": {
   "search": [
   {
   "names": ["logs*"]
   }
   ]
  },
  "metadata": {
   "application": "search"
  }
}

成功した呼び出しは、APIキー情報を提供するJSON構造を返します。例えば:

コンソール-結果

{
  "id": "VuaCfGcBCdbkQm-e5aOx",
  "name": "my-cross-cluster-api-key",
  "api_key": "ui2lp2axTNmsyakw9tvNnw",
  "encoded": "VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw=="
}

APIキーの情報、特にその正確なロールディスクリプタは、APIキーを取得するAPIで確認できます。

Python

resp = client.security.get_api_key(
   id="VuaCfGcBCdbkQm-e5aOx",
)
print(resp)

Js

const response = await client.security.getApiKey({
  id: "VuaCfGcBCdbkQm-e5aOx",
});
console.log(response);

コンソール

GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx

成功した呼び出しは、APIキーの情報を含むJSON構造を返します:

Js

{
  "api_keys": [
   {
   "id": "VuaCfGcBCdbkQm-e5aOx",
   "name": "my-cross-cluster-api-key",
   "type": "cross_cluster",
   "creation": 1548550550158,
   "expiration": null,
   "invalidated": false,
   "username": "myuser",
   "realm": "native1",
   "metadata": {
   "application": "search"
   },
   "role_descriptors": {
   "cross_cluster": {
   "cluster": [
   "cross_cluster_search"
   ],
   "indices": [
   {
   "names": [
   "logs*"
   ],
   "privileges": [
   "read", "read_cross_cluster", "view_index_metadata"
   ],
   "allow_restricted_indices": false
   }
   ],
   "applications": [ ],
   "run_as": [ ],
   "metadata": { },
   "transient_metadata": {
   "enabled": true
   }
   }
   },
   "access": {
   "search": [
   {
   "names": [
   "logs*"
   ],
   "allow_restricted_indices": false
   }
   ]
   }
   }
  ]
}

次の例は、上記で作成されたAPIキーを更新し、新しいアクセス範囲とメタデータを割り当てます:

Python

resp = client.perform_request(
   "PUT",
   "/_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx",
   headers={"Content-Type": "application/json"},
   body={
   "access": {
   "replication": [
   {
   "names": [
   "archive"
   ]
   }
   ]
   },
   "metadata": {
   "application": "replication"
   }
   },
)
print(resp)

Js

const response = await client.transport.request({
  method: "PUT",
  path: "/_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx",
  body: {
   access: {
   replication: [
   {
   names: ["archive"],
   },
   ],
   },
   metadata: {
   application: "replication",
   },
  },
});
console.log(response);

コンソール

PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx
{
  "access": {
   "replication": [
   {
   "names": ["archive"]
   }
   ]
  },
  "metadata": {
   "application": "replication"
  }
}

成功した呼び出しは、APIキーが更新されたことを示すJSON構造を返します:

コンソール-結果

{
  "updated": true
}

更新後のAPIキーの権限は、再度APIキーを取得するAPIで確認でき、次のようになります:

Js

{
  "api_keys": [
   {
   "id": "VuaCfGcBCdbkQm-e5aOx",
   "name": "my-cross-cluster-api-key",
   "type": "cross_cluster",
   "creation": 1548550550158,
   "expiration": null,
   "invalidated": false,
   "username": "myuser",
   "realm": "native1",
   "metadata": {
   "application": "replication"
   },
   "role_descriptors": {
   "cross_cluster": {
   "cluster": [
   "cross_cluster_replication"
   ],
   "indices": [
   {
   "names": [
   "archive*"
   ],
   "privileges": [
   "cross_cluster_replication", "cross_cluster_replication_internal"
   ],
   "allow_restricted_indices": false
   }
   ],
   "applications": [ ],
   "run_as": [ ],
   "metadata": { },
   "transient_metadata": {
   "enabled": true
   }
   }
   },
   "access": {
   "replication": [
   {
   "names": [
   "archive*"
   ],
   "allow_restricted_indices": false
   }
   ]
   }
   }
  ]
}