Post v1+name:decapsulate — cloudkms

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-134796204.9 KB

projects

Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.

post/v1/{+name}:decapsulate

Path parameters

namestring required

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

Request body

ciphertextstring byte

Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).

ciphertextCrc32cstring int64

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

Response

Successful response