ルート鍵または標準鍵に関する詳細の表示

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

ルート・キーまたは標準キーを取得するには、_「ライター」または「マネージャー」_のアクセス権限ポリシーが必要ですが、キー自体は取得することなく、ルート・キーまたは標準キー (遷移履歴や構成など) に関する詳細のみを表示する方法が必要な場合があります。 _「リーダー」_アクセス権限がある場合は、Hyper Protect Crypto Services キー管理 API を使用して、ルート・キーまたは標準キーに関するメタデータのみをリトリーブできます。

UI を使用した鍵の詳細の表示

以下のステップを実行することで、UI を使用して特定の鍵に関する詳細を表示できます。

UI にログインします。
「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。
**「KMS 鍵 (KMS keys)」ページで、「鍵」**テーブルを使用して、このサービスの鍵を参照します。
アクション・アイコンをクリックして、特定のキーのオプションのリストを開きます。
オプション・メニューから、**「鍵の詳細の表示」**をクリックして鍵の詳細を表示します。

キー管理サービス API を使用したキーの詳細の表示

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

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata

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

この ID 値を使用して、鍵に関する詳細情報にアクセスします。サービス・インスタンス内の鍵の ID は、以下の方法で確認できます。鍵のリストの取得、または UI へのアクセス。

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

curl -X GET \
  'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/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>'

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

表 1. API を使用して鍵に関する詳細を表示するために必要な変数について説明します。
変数	説明
`region`	必須。 Hyper Protect Crypto Services インスタンスが存在する地理的領域を表す地域の省略形 ( `us-south` や `eu-de` など)。詳細については、リージョナル・サービス・エンドポイントを参照してください。
`key_ID_or_alias`	必須。検査する鍵の ID または別名。
`IAM_token`	必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、`IAM` トークンの全コンテンツを cURL 要求に組み込みます。詳細については、アクセス・トークンのリトリーブを参照してください。
`instance_ID`	必須。 Hyper Protect Crypto Services インスタンスに割り当てられた固有 ID。詳細については、インスタンス ID のリトリーブを参照してください。
`key_ring_ID`	オプション。鍵が属する鍵リングの固有 ID。指定しないと、Hyper Protect Crypto Services は、指定されたインスタンスに関連付けられているすべての鍵リングで鍵を検索します。このため、鍵リング 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",
      "state": 1,
      "extractable": true,
      "crn": "crn:v1:bluemix:public:hs-crypto: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": "AES",
      "algorithmMetadata": {
        "bitLength": "256",
        "mode": "CBC_PAD"
      },
      "algorithmBitSize": 256,
      "algorithmMode": "CBC_PAD",
      "lastUpdateDate": "2020-03-12T03:50:12Z",
      "dualAuthDelete": {
        "enabled": false
      },
      "deleted": false
    }
  ]
}

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

応答パラメーターの詳細な説明については、以下を参照してください。 Hyper Protect Crypto Services の鍵管理 REST API リファレンス資料。