unwrap Key - unwrap Key

Tjänst:

Key Vault

API-version:

7.4

Hämtar en symmetrisk nyckel med den angivna nyckeln som ursprungligen användes för att omsluta nyckeln.
UNWRAP-åtgärden stöder dekryptering av en symmetrisk nyckel med hjälp av krypteringsnyckeln för målnyckeln. Den här åtgärden är motsatsen till WRAP-åtgärden. UNWRAP-åtgärden gäller för asymmetriska och symmetriska nycklar som lagras i Azure Key Vault eftersom den använder den privata delen av nyckeln. Den här åtgärden kräver behörigheten keys/unwrapKey.

POST {vaultBaseUrl}/keys/{key-name}/{key-version}/unwrapkey?api-version=7.4

URI-parametrar

Name	I	Obligatorisk	Typ	Description
key-name	path	True	string	Namnet på nyckeln.
key-version	path	True	string	Versionen av nyckeln.
vaultBaseUrl	path	True	string	Valvnamnet, till exempel https://myvault.vault.azure.net.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
alg	True	JsonWebKeyEncryptionAlgorithm minLength: 1	algoritmidentifierare
value	True	string (base64url)
aad		string (base64url)	Ytterligare data för att autentisera men inte kryptera/dekryptera när du använder autentiserade kryptoalgoritmer.
iv		string (base64url)	Kryptografiskt slumpmässig, icke-upprepande initieringsvektor för symmetriska algoritmer.
tag		string (base64url)	Taggen som ska autentiseras när dekryptering utförs med en autentiserad algoritm.

Svar

Name	Typ	Description
200 OK	KeyOperationResult	Den oöppnade symmetriska nyckeln.
Other Status Codes	KeyVaultError	Key Vault-felsvar som beskriver varför åtgärden misslyckades.

Exempel

Unwrapkey

Exempelbegäran

HTTP

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"
}

Exempelsvar

Statuskod:

200

{
  "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6",
  "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo"
}

Definitioner

Name	Description
Error	Key Vault-serverfelet.
JsonWebKeyEncryptionAlgorithm	algoritmidentifierare
KeyOperationResult	Resultatet av nyckelåtgärden.
KeyOperationsParameters	Nyckelåtgärdsparametrarna.
KeyVaultError	Felfelet för nyckelvalvet.

Error

Objekt

Key Vault-serverfelet.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Key Vault-serverfelet.
message	string	Felmeddelandet.

JsonWebKeyEncryptionAlgorithm

Uppräkning

algoritmidentifierare

Värde	Description
A128CBC
A128CBCPAD
A128GCM
A128KW
A192CBC
A192CBCPAD
A192GCM
A192KW
A256CBC
A256CBCPAD
A256GCM
A256KW
RSA-OAEP
RSA-OAEP-256
RSA1_5

KeyOperationResult

Objekt

Resultatet av nyckelåtgärden.

Name	Typ	Description
aad	string (base64url)
iv	string (base64url)
kid	string	Nyckelidentifierare
tag	string (base64url)
value	string (base64url)

KeyOperationsParameters

Objekt

Nyckelåtgärdsparametrarna.

Name	Typ	Description
aad	string (base64url)	Ytterligare data för att autentisera men inte kryptera/dekryptera när du använder autentiserade kryptoalgoritmer.
alg	JsonWebKeyEncryptionAlgorithm minLength: 1	algoritmidentifierare
iv	string (base64url)	Kryptografiskt slumpmässig, icke-upprepande initieringsvektor för symmetriska algoritmer.
tag	string (base64url)	Taggen som ska autentiseras när dekryptering utförs med en autentiserad algoritm.
value	string (base64url)

KeyVaultError

Objekt

Felfelet för nyckelvalvet.

Name	Typ	Description
error	Error	Key Vault-serverfelet.