POST /platform/v1/key

Overview

Creates or imports an encryption key for bring your own key (BYOK) for TDE. Data at Rest Encryption is a prerequisite for this feature.

URL Parameters

NameTypeDescription
x-request-idstringHeader parameter: Request ID for the request. Default Format: 52e3ca33-c54a-4bbe-824c-419ff9a46860.
x-mccs-user-contextstringHeader parameter: Indicates the MCCS user context. Example: EID=111;MID=111;EmployeeId=111.
x-mccs-keystore-providerstringHeader parameter: Specify a key store provider to use for an ImportKey or WrappingKey request. Examples: kms, keysecure, database. Default: keysecure.
x-mccs-macstringHeader parameter: Specify the message authentication code for the request.

JSON Parameters

NameTypeDescription
keyNamestringRequiredundefined
keyIdstringFormat: GUID.
keyVersionintegerFormat: int32.
keyTypestringRequiredundefined
midintegerRequiredFormat: int64.
eidintegerFormat: int64.
keySizeintegerRequiredFormat: int32.
keyStatestringundefined
exportablebooleanundefined
createdDatestringundefined
employeeIdintegerFormat: int32.
modifiedDatestringundefined
modifiedByintegerFormat: int32.
keyData.wrappedRsaBytesstringundefined
keyData.digitalSignaturestringundefined
keyData.initializationVectorstringIV may be required when you wrap with an AES key.
keyData.wrappedAesBytesstringundefined

Usage

Example Request

Example Response