UI でキーを削除する

デフォルトでは、鍵を削除するために Hyper Protect Crypto Services が必要とする許可は 1 つです。 グラフィカル インターフェイスを使用して暗号化キーを削除する場合は、UI を使用できます。

サービス内に鍵を作成するか、既存の鍵をインポートした後、鍵を削除するには以下の手順を実行します。

1. UI にログインします。
2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。
4. **「KMS 鍵 (KMS keys)」ページで、「鍵」**テーブルを使用して、このサービスの鍵を参照します。
5. 削除したいキーを選択し、アクション・アイコン をクリックしてそのキーのオプションのリストを開きます。
6. オプション・メニューから、**「鍵の削除 (Delete key)」をクリックし、削除する鍵を確認するために鍵名を入力してから、「鍵の削除 (Delete key)」**をクリックします。

キーを削除すると、キーは破棄状態に移行します。 削除された鍵を復元できるのは、削除してから 30 日以内です。 鍵の削除日など、鍵に関連付けられているメタデータは、Hyper Protect Crypto Services データベースに保管されます。

API を使用した鍵の削除

デフォルトでは、鍵を削除するために Hyper Protect Crypto Services が必要とする許可は 1 つです。 鍵とその内容を削除するには、以下のようにします。 以下のエンドポイントに DELETE 呼び出しを実行します。

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

対象の鍵で 1 つ以上のクラウド・リソースが現在保護されている場合は、この操作は成功しません。 鍵と関連付けられているリソースを確認するか、または、鍵を削除するための照会時に force パラメーターを使用してください。

1. サービス内で鍵の処理を行うために、サービス資格情報および認証資格情報を取得します。

2. 削除する鍵の ID を取得します。

   サービスインスタンス内のキーのIDは、次の方法で見つけることができます。キーのリストを取得しています、または UI にアクセスして行います。

3. 次の cURL コマンドを実行して、鍵とその内容を完全に削除します。

   curl -X DELETE \
     "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>" \
     -H "authorization: Bearer <IAM_token>" \
     -H "bluemix-instance: <instance_ID>" \
     -H "x-kms-key-ring: <key_ring_ID>" \
     -H "prefer: <return_preference>"
   

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

   表 1. API を使用して鍵を削除するために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south または au-syd、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   key_ID	必須。 削除する鍵の固有 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 になります。 詳しくは、鍵リングの管理を参照してください。
   return_preference	サーバーの動作を変更するヘッダー POST そして DELETE オペレーション。 設定すると return_preference 変数に return=minimal サービスは削除成功の応答を返します。 変数を return=representation に設定すると、サービスは鍵の素材と鍵のメタデータの両方を返します。

   return_preference 変数を return=representation に設定すると、DELETE 要求の詳細が応答のエンティティー本体で返されます。

   次の 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-root-key",
               "aliases": [
                   "alias-1",
                   "alias-2"
                 ],
               "state": 5,
               "extractable": false,
               "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-10T20:41:27Z",
               "createdBy": "...",
               "algorithmType": "AES",
               "algorithmMetadata": {
                   "bitLength": "256",
                   "mode": "CBC_PAD"
               },
               "algorithmBitSize": 256,
               "algorithmMode": "CBC_PAD",
               "lastUpdateDate": "2020-03-16T20:41:27Z",
               "dualAuthDelete": {
                   "enabled": false
               },
               "deleted": true,
               "deletionDate": "2020-03-16T21:46:53Z",
               "deletedBy": "..."
           }
       ]
   }
   

   利用可能なパラメータの詳細については、Hyper Protect Crypto Servicesキー管理サービス API リファレンス ドキュメント。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>?force=true