Envelope Encryption

Envelope encryption material

Create encryption material

Create encryption material for in-app encryption

post

Headers

X-Konnect-CMEK-Idstring

The CMEK ID to use for encryption and decryption

Default:default

Response

application/json

Response for encryption material

encrypted_data_keystringrequired

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=

plaintext_data_keystringrequired

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==

post/materials/encryption
 
application/json

Create decryption material

Create decryption material for in-app decryption

post

Body

application/json

Request body schema to retrieve decryption material

encrypted_data_keystringrequired

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 for decryption material

plaintext_data_keystringrequired

The plaintext data key to use for decryption, base64 encoded.

Example:ZGVjcnlwdGlvbi1tYXRlcmlhbA==

post/materials/decryption

Body

{ "encrypted_data_key": "ZW5jcnlwdGlvbi1rZXk=" }
 
application/json

CMEK

object
idstringrequired
key_arnstringrequired

The ARN of the KMS key to use for encryption

Example:arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

namestringrequired
descriptionstring
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

ListCMEKs

object
dataarray[object]required
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
Example