Key Management Service API, REST: SymmetricCrypto.Decrypt

Статья создана

Обновлена 26 ноября 2024 г.

Decrypts the given ciphertext with the specified key.

HTTP request

POST https://kms.yandex/kms/v1/keys/{keyId}:decrypt

Field

Description

keyId

string

Required field. ID of the symmetric KMS key to use for decryption.

{
  "aadContext": "string",
  "ciphertext": "string"
}

Field

Description

aadContext

string (bytes)

Additional authenticated data, must be the same as was provided
in the corresponding SymmetricEncryptRequest.
Should be encoded with base64.

ciphertext

string (bytes)

Required field. Ciphertext to be decrypted.
Should be encoded with base64.

HTTP Code: 200 - OK

{
  "keyId": "string",
  "versionId": "string",
  "plaintext": "string"
}

Field	Description
keyId	string ID of the symmetric KMS key that was used for decryption.
versionId	string ID of the key version that was used for decryption.
plaintext	string (bytes) Decrypted plaintext.