Create encryption material
Create encryption material for in-app encryption
Headers
The CMEK ID to use for encryption and decryption
Default:default
Response
application/json
Response
Response for encryption material
The encrypted data key used for encryption, base64 encoded. This key is used to retrieve the plaintext data key for decryption and should be stored along with the encrypted data.
Example:ZW5jcnlwdGlvbi1rZXk=
The plaintext data key used for encryption, base64 encoded. This key is used to encrypt the data key and should be thrown away after use.
Example:ZGVjcnlwdGlvbi1tYXRlcmlhbA==
Authentication
Headers
Create decryption material
Create decryption material for in-app decryption
Body
application/json
Body
Request body schema to retrieve decryption material
The encrypted data key used for encryption, base64 encoded. This key is used to retrieve the plaintext data key for decryption.
Example:ZW5jcnlwdGlvbi1rZXk=
Response
application/json
Response
Response for decryption material
The plaintext data key to use for decryption, base64 encoded.
Example:ZGVjcnlwdGlvbi1tYXRlcmlhbA==
Authentication
Body
CMEK
objectThe ARN of the KMS key to use for encryption
Example:arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
ListCMEKs
objectShow Child Parameters
Pagination metadata.
Show Child Parameters
Error
objectstandard error
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
The error type.
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.