Decrypting the Data using an Asymmetric Key

The post /v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/asymmetric-decrypt API decrypts a ciphertext payload using an encryption key stored in a keystore on CipherTrust Manager. The key specified in the key_id path variable MUST be an asymmetric key with ENCRYPT and DECRYPT attributes.

The API decrypts the ciphertext payload using the specified algorithm. The algorithm and key version ID must be the same as those used to encrypt the plaintext data, otherwise, the decrypt operation fails.

Request Parameters

Parameter	Type	Description
ciphertext	string	A byte array that appears as a base64 encoded string in the JSON blob.
algorithm	string	The algorithm of encryption. It can be `RSAES_OAEP_SHA_1`, `RSAES_OAEP_SHA_256`, `RSAES_OAEP_SHA_384`, or `RSAES_OAEP_SHA_512`.
sap_tenant_id	string	ID of the SAP Tenant.
sap_group_id (optional)	string	ID of the SAP Group .
sap_user_type (optional)	string	Type of the SAP user.
sap_request_id (optional)	string	Request ID of the call made to SAP DC KMS to correlate the SAP audit record with the CipherTrust Manager audit record.

Example Request

post https://<Host IP Address>/api/v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/asymmetric-decrypt
<authorization token and other headers>
{
    "ciphertext": "r+w/3HlhsYb7sj9fM+RQVIse4ERLQGWz+s/Ojnqu+vpA6H9AFDVd2Ij7ZS4u1bPmb2wQp4SQIAv6nXK9h60cOsyX7CgtVr864hmc/b5YJ+6KS46PZogEUYWkPceBhSau1NG1dovBR64g4QAqFc66V1XdArKM0PeKy1rBJidnT0Y/rjPLM++mD0/lmVBrH7K0mioy8becWWE2Na+eLqpvDwY23grMraMZ8gPik5cflejMfjXUAMTRc0Ownn5kAiW1wOTaT5ONmPsOPF9N4yyTOA9xmQFFEVj7gQviYholMXWWfLERh4dlHRMbMccD9PlrnxonVA9VHGqcWR+ChTQ6ftcn9D7YVXGM23+Nz9ECc2HZi67/HPd5bpVE2MNRDxLz/mva8dqwguk4rvv2C3X2EAgmPyzIcfoHLMkZhooR+ytg3DyHJytEGPy4HxpJVP/zTbYzcYjdNw3mnfD3EduZ+Dd5IQmhUKI2VfT4B75vl7D2whl8spZ+Rl84iWWw2VTS9eAJtX5U24NUg3WF+qsNjmYDTfxGBo3XFL+KM8ywPT6+wNCLBDRfKZ5/fYzf0oVtpv9dlcszTrbPh1Un7mE+YLuv1Rz9zvrLWt8NWRiHhITiCKpMw4E8u6UZPmlm4mJwMeLlOCA+upZr6WuX/Dj7SygnVNC4ZMMTmaW/A3wXKek=",
    "algorithm": "RSAES_OAEP_SHA_1",
    "request_metadata": {
            "sap_tenant_id": "5e3d1d87-9502-42af-a946-3ffec9e71a44",
            "sap_group_id": "0dab7383-fa9b-4540-bcc7-fe03a6f59487",
            "sap_user_type": "USER_DEV",
            "sap_request_id": "86428acc-a1c8-6de1-b8f7-8de9a436gdr3"
    }
}

Example Response

{
    "plaintext": "dGVzdGluZw=="
}

Response Codes

Response Code	Description
200	Ok
400	Bad request
401	Unauthorized
404	Not found
403	Forbidden
500	Internal server error

Refer to HTTP status codes for details.

Decrypting the Data using an Asymmetric Key

Request Parameters

Example Request

Example Response

Response Codes

On this page

Suggest A Change