unwrap Key - unwrap Key
最初にそのキーをラップするために使用された指定したキーを使用して、対称キーのラップを解除します。
UNWRAP 操作では、ターゲット キー暗号化キーを使用した対称キーの暗号化解除がサポートされます。 この操作は WRAP 操作の逆です。 UNWRAP 操作は、キーの秘密部分を使用するため、Azure Key Vault に格納されている非対称キーと対称キーに適用されます。 この操作には、キー/unwrapKey アクセス許可が必要です。
POST {vaultBaseUrl}/keys/{key-name}/{key-version}/unwrapkey?api-version=7.4
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
key-name
|
path | True |
string |
キーの名前。 |
key-version
|
path | True |
string |
キーのバージョン。 |
vault
|
path | True |
string |
コンテナー名 ( |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
alg | True | minLength: 1 |
アルゴリズム識別子 |
value | True |
string (base64url) |
|
aad |
string (base64url) |
認証された暗号化アルゴリズムを使用する場合は、認証するが暗号化/暗号化解除を行わない追加データ。 |
|
iv |
string (base64url) |
対称アルゴリズムに対する暗号的にランダムな非繰り返し初期化ベクトル。 |
|
tag |
string (base64url) |
認証されたアルゴリズムを使用して復号化を実行するときに認証するタグ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
ラップされていない対称キー。 |
|
Other Status Codes |
操作が失敗した理由を説明する Key Vault エラー応答。 |
例
Unwrapkey
要求のサンプル
POST https://myvault.vault.azure.net//keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6/unwrapkey?api-version=7.4
{
"alg": "RSA1_5",
"value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw"
}
応答のサンプル
{
"kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
"value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}
定義
名前 | 説明 |
---|---|
Error |
キー コンテナー サーバー エラー。 |
Json |
アルゴリズム識別子 |
Key |
キー操作の結果。 |
Key |
主要な操作パラメーター。 |
Key |
キー コンテナーのエラー例外。 |
Error
キー コンテナー サーバー エラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
innererror |
キー コンテナー サーバー エラー。 |
|
message |
string |
エラー メッセージ。 |
JsonWebKeyEncryptionAlgorithm
アルゴリズム識別子
値 | 説明 |
---|---|
A128CBC | |
A128CBCPAD | |
A128GCM | |
A128KW | |
A192CBC | |
A192CBCPAD | |
A192GCM | |
A192KW | |
A256CBC | |
A256CBCPAD | |
A256GCM | |
A256KW | |
RSA-OAEP | |
RSA-OAEP-256 | |
RSA1_5 |
KeyOperationResult
キー操作の結果。
名前 | 型 | 説明 |
---|---|---|
aad |
string (base64url) |
|
iv |
string (base64url) |
|
kid |
string |
キー識別子 |
tag |
string (base64url) |
|
value |
string (base64url) |
KeyOperationsParameters
主要な操作パラメーター。
名前 | 型 | 説明 |
---|---|---|
aad |
string (base64url) |
認証された暗号化アルゴリズムを使用する場合は、認証するが暗号化/暗号化解除を行わない追加データ。 |
alg | minLength: 1 |
アルゴリズム識別子 |
iv |
string (base64url) |
対称アルゴリズムに対する暗号的にランダムな非繰り返し初期化ベクトル。 |
tag |
string (base64url) |
認証されたアルゴリズムを使用して復号化を実行するときに認証するタグ。 |
value |
string (base64url) |
KeyVaultError
キー コンテナーのエラー例外。
名前 | 型 | 説明 |
---|---|---|
error |
キー コンテナー サーバー エラー。 |