鍵メタデータの取得

単一の暗号キーの一般的な特性をリトリーブするには、以下を使用します。 IBM® Key Protect for IBM Cloud®.

単一の鍵への詳細に設定されたアクセスを割り当てることはできますが、鍵のリスト API を呼び出しても、個々のアクセスを割り当てた鍵 (つまり、アクセスできるのは自分のみである) は返されないことに注意してください。ただし、この API を呼び出すと、アクセスできる鍵リング内の鍵が返されます (インスタンス内のすべての鍵にアクセスできる場合は、すべての鍵が表示されます)。ただし、IAM を介して鍵を表示するための鍵へのアクセス権限の付与の手順に従うか、API を使用して特定の鍵 ID を渡すことによって、自分だけがアクセスできる鍵を表示することができます。

鍵を取得するには_ライター_アクセス・ポリシーまたは_マネージャー_のアクセス・ポリシーが必要ですが、鍵自体を取得せずに、鍵に関する詳細 (遷移履歴や構成など) のみを表示する方法が必要な場合があります。 _リーダー_権限を持っている場合、Key ProtectAPIを使用することができます。APIを使用して、キーに関するメタデータのみを取得することができます。

API を使用した鍵メタデータの表示

特定の鍵に関する詳細情報を表示するには、次のエンドポイントに対して GET 呼び出しを行います。

https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>/metadata

サービス内で鍵の処理を行うために、認証資格情報を取得します。
検査する鍵の ID を取得します。

この ID 値を使用して、鍵に関する詳細情報にアクセスします。鍵の ID は、以下の場所にあります。 Key Protect インスタンスの鍵の ID は、鍵のリストを取得するか、または Key Protect ダッシュボードにアクセスすることで見つけることができます。ダッシュボード

次の curl コマンドを実行して、鍵に関する詳細を取得します。

$ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>/metadata" \
    -H "accept: application/vnd.ibm.kms.key+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>" \
    -H "x-kms-key-ring: <key_ring_ID>" \
    -H "correlation-id: <correlation_ID>"

次の表に従って、例の要求内の変数を置き換えてください。

変数	説明
リージョン	必須。 Key Protect インスタンスが

        存在している地理的領域を表す、
        地域の省略形
        (例: `us-south` または
        `eu-gb`)。 詳細については、[リージョナル・サービス・エンドポイント](/docs/key-protect?topic=key-protect-regions#service-endpoints)を参照してください。 |

| keyID_or_alias | 必須。検査対象となる鍵の固有 ID または別名。 | | IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを curl 要求に組み込みます。詳細については、アクセス・トークンのリトリーブを参照してください。 | | instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。詳細については、インスタンス ID のリトリーブを参照してください。 | | key_ring_ID | オプション。鍵が含まれている鍵リングの固有 ID。ヘッダー自体はオプションですが、指定しない場合、Key Protect は指定されたインスタンスに関連付けられたすべての鍵リングで鍵を検索します。鍵リング ID を指定して、より最適化された要求を行うことをお勧めします。注: x-kms-key-ring ヘッダーを指定せずに作成した鍵の鍵リング ID は「default」になります。詳しくは、鍵のグループ化を参照してください。 | | correlation_ID | オプション。トランザクションを追跡し、相互に関連付けるために使用される固有 ID。 |

GET api/v2/keys/<key_ID_or_alias>/metadata の応答が成功すると、キーに関する詳細が返されます。以下の JSON オブジェクトは、標準鍵の戻り値の例を示しています。

{
		"metadata": {
				"collectionType": "application/vnd.ibm.kms.key+json",
				"collectionTotal": 1
		},
		"resources": [
				{
						"type": "application/vnd.ibm.kms.key+json",
						"id": "02fd6835-6001-4482-a892-13bd2085f75d",
						"name": "test-standard-key",
						"aliases": [
								"alias-1",
								"alias-2"
						],
						"state": 1,
						"expirationDate": "2020-03-15T03:50:12Z",
						"extractable": true,
						"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
						"imported": false,
						"creationDate": "2020-03-12T03:50:12Z",
						"createdBy": "...",
						"algorithmType": "Deprecated",
						"algorithmMetadata": {
								"bitLength": "256",
								"mode": "Deprecated"
						},
						"algorithmBitSize": 256,
						"algorithmMode": "Deprecated",
						"lastUpdateDate": "2020-03-12T03:50:12Z",
						"dualAuthDelete": {
								"enabled": false
						},
						"deleted": false
				}
		]
}

次のステップ

標準鍵の payload 値を取得する必要がある場合、詳しくは、鍵の取得を参照してください。

応答パラメーターの詳細な説明については、以下を参照してください。 Key Protect REST APIリファレンスドキュメント