v8

latestSwagger 2.02026-07-13254292.3 KB

Decrypts a single block of encrypted data.

The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission. Microsoft recommends not to use CBC algorithms for decryption without first ensuring the integrity of the ciphertext using an HMAC, for example. See https://learn.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode for more information.

post/keys/{key-name}/{key-version}/decrypt

Path parameters

key-namestring required

The name of the key.

key-versionstring required

The version of the key.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

alg'RSA-OAEP' | 'RSA-OAEP-256' | 'RSA1_5' | 'A128GCM' | 'A192GCM' | 'A256GCM' | 'A128KW' | 'A192KW' | 'A256KW' | 'A128CBC' | 'A192CBC' | 'A256CBC' | 'A128CBCPAD' | 'A192CBCPAD' | 'A256CBCPAD' | 'CKM_AES_KEY_WRAP' | 'CKM_AES_KEY_WRAP_PAD' required

An algorithm used for encryption and decryption.

valuestring base64url required

The value to operate on.

ivstring base64url

Cryptographically random, non-repeating initialization vector for symmetric algorithms.

aadstring base64url

Additional data to authenticate but not encrypt/decrypt when using authenticated crypto algorithms.

tagstring base64url

The tag to authenticate when performing decryption with an authenticated algorithm.

Response

The request has succeeded.

kidstring

Key identifier

valuestring base64url

The result of the operation.

ivstring base64url

Cryptographically random, non-repeating initialization vector for symmetric algorithms.

tagstring base64url

The tag to authenticate when performing decryption with an authenticated algorithm.

aadstring base64url

Additional data to authenticate but not encrypt/decrypt when using authenticated crypto algorithms.