コンソールでの鍵の別名の作成と編集

鍵の別名は、鍵の作成またはインポートのプロセス中に鍵に追加できます。

• ルート鍵または標準鍵の作成方法について詳しくは、ルート鍵の作成または標準鍵の作成を参照してください。
• ルート鍵または標準鍵のインポート方法について詳しくは、ルート鍵のインポートまたは標準鍵のインポートを参照してください。

キーエイリアスを編集するには、⋯をクリックし、「 エイリアスの編集 」を選択します。 タブに、鍵に割り当てられている既存の別名が表示されます (別名を削除することもできます)。別名を追加することもできます。 鍵には最大 5 つの別名を指定できます。

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

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

https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/aliases/<alias>

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

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

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

   $ curl -X POST \
       "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/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>"
   

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

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

| keyID_or_alias | 必須。 別名に関連付ける鍵の ID または別名。 キー ID をリトリーブするには、キーのリスト APIを参照してください。 | | key_alias | 必須。 鍵を簡単に識別するための、人間が理解できる固有の名前。

エイリアスは英数字で構成され、大文字と小文字が区別され、スペースや、ダッシュ（-）およびアンダースコア（_）以外の特殊文字を含んではなりません。 エイリアスはバージョン 4 の UUID であることはできず、 Key Protect で予約されている名前（allowed_ip、key、keys、metadata、policy、policies、registration、registrations、ring、rings、rotate、wrap、unwrap、rewrap、version、 versions.Alias ）であってはなりません。長さは 2 ～ 90 文字（両端を含む）です。

注： Key Protect インスタンス内では、エイリアス名の重複は許可されません。 | | IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。

詳細については、「 アクセストークンの取得」を参照してください。 | | instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。

詳細については、「 インスタンス ID の取得 」を参照してください。 | | correlation_ID | オプション。トランザクションを追跡し、相互に関連付けるために使用される固有 ID。 |

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

POST api/v2/keys/<keyID_or_alias>/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": "..."
        }
    ]
}

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

鍵ごとに最大 5 つの別名を指定できます。 別名にはインスタンス 1 つあたり 1,000 個という制限があります。

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

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

https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/aliases/<alias>

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

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

   $ curl -X DELETE \
       "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/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>"
   

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

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

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

鍵の別名を使用する API

以下の表に、鍵の別名を作成して使用するために使用できる API をリストします。