UI でキーエイリアスを作成する

次の手順を実行して、UI を使用してキー エイリアスを作成します。

1. UI にログインします。

2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。

3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。

4. サイド・メニューで**「KMS 鍵 (KMS keys)」**タブを選択し、鍵の別名を作成する鍵を見つけます。

5. アクション・アイコンをクリックして、キーのオプションのリストを開き、**「キー・エイリアスの編集」**をクリックします。

6. 鍵の別名をコンマで区切って入力します。 鍵には最大 5 つの別名を追加できます。

   各エイリアスは英数字で、大文字小文字の区別があります。また、ダッシュ (-) またはアンダースコア (_) 以外のスペースや特殊文字は使用できません。 エイリアスにバージョン 4 UUID は使用できません。Hyper Protect Crypto Services 予約名 (allowed_ip、key、keys、metadata、policy、policies、registration、registrations、ring、rings、rotate、wrap、unwrap、rewrap、version、versions) も使用できません。エイリアスのサイズは、2 文字以上 90 文字以下とします。

7. 保存 をクリックします。

API を使用した鍵の別名の作成

以下のエンドポイントに POST 呼び出しを実行して、鍵の別名を作成します。

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

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

   キー・エイリアスを作成するには、「マネージャー」または「ライター」 のサービス・アクセス権限ロールが割り当てられている必要があります。 IAM ロールがどのように Hyper Protect Crypto Services サービス・アクションにマップされるかについて詳しくは、サービス・アクセス権限ロールを参照してください。

2. 以下の curl コマンドを実行して、鍵の別名を作成します。

   $ curl -X POST \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<key_alias>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.key+json" \
       -H "correlation-id: <correlation_ID>"
   

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

   表 1. Hyper Protect Crypto Services API を使用して鍵の別名を作成するために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south 、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   key_ID	必須。 別名を関連付ける鍵の ID。 キー ID をリトリーブするには、キーのリスト APIを参照してください。
   key_alias	必須。 鍵を簡単に識別するための、人間が理解できる固有の名前。 各エイリアスは英数字で、大文字と小文字が区別され、スペースやダッシュ（-）またはアンダースコア（_）以外の特殊文字を含めることはできません。エイリアスはバージョン4のUUIDにすることはできず、Hyper Protect Crypto Services予約名:allowed_ip 、key 、keys 、metadata 、policy 、policies 、registration 、registrations 、ring 、rings 、rotate 、wrap 、unwrap 、rewrap 、version 、versions エイリアスのサイズは 2 〜 90 文字です。 注記： 重複したエイリアス名を持つことはできませんHyper Protect Crypto Services実例。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 完全な内容を含める IAM ベアラー値を含むトークンを curl リクエスト。 詳しくは、アクセス・トークンの取得を参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services サービス・インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。
   correlation_ID	トランザクションを追跡し、相互に関連付けるために使用される固有 ID。

   個人データの機密性を保護するため、鍵の別名を作成するときに、 個人の名前や住所などの個人情報 (PII) を入力しないようにしてください。 PIIのその他の例については、セクションを参照してください。2.2の NIST 特別出版物 800-122。

   POST api/v2/keys/<key_ID>/aliases/<key_alias> 応答が成功すると、キーのエイリアスとその他のメタデータが返されます。 別名は、 鍵に割り当てられる固有の名前であるため、別名を使用して、関連付けられている鍵に関する詳細情報を取得できます。

   {
       "metadata": {
           "collectionType": "application/vnd.ibm.kms.key+json",
           "collectionTotal": 1
       },
       "resources": [
           {
               "keyId": "02fd6835-6001-4482-a892-13bd2085f75d",
               "alias": "test-alias",
               "creationDate": "2020-03-12T03:37:32Z",
               "createdBy": "..."
           }
       ]
   }
   

   応答パラメータの詳細な説明については、Hyper Protect Crypto ServicesREST API リファレンス ドキュメント。

UI を使用してキーエイリアスを削除する

次の手順を実行して、UI を使用してキー エイリアスを削除します。

1. UI にログインします。
2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。
4. サイド・メニューで**「KMS 鍵 (KMS keys)」**タブを選択し、鍵の別名を作成する鍵を見つけます。
5. アクション・アイコンをクリックして、キーのオプションのリストを開き、**「キー・エイリアスの編集」**をクリックします。
6. 削除対象の鍵の別名を削除し、**「保存」**をクリックします。

API を使用した鍵の別名の削除

以下のエンドポイントに DELETE 呼び出しを実行して、鍵の別名を削除します。

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

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

2. 以下の curl コマンドを実行して、鍵の別名を削除します。

   $ curl -X DELETE \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<key_alias>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.key+json" \
       -H "correlation-id: <correlation_ID>"
   

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

   表 2. Hyper Protect Crypto Services API を使用して鍵の別名を削除するために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south 、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   key_ID	必須。 鍵の固有 ID。
   key_alias	必須。 鍵を識別する、人間が理解できる固有の名前。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 完全な内容を含める IAM ベアラー値を含むトークンを curl リクエスト。 詳しくは、アクセス・トークンの取得を参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services サービス・インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。
   correlation_ID	トランザクションを追跡し、相互に関連付けるために使用される固有 ID。

   DELETE api/v2/keys/<key_ID>/aliases/<key_alias> 要求が成功すると、キーに関連付けられたエイリアスが削除されたことを示す HTTP 204 No Content 応答が返されます。

   別名がサービスから削除されるまで最大 10 分かかります。