POST /platform/v1/key

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

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

Name	Type		Description
keyName	string	Required	undefined
keyId	string		Format: GUID.
keyVersion	integer		Format: int32.
keyType	string	Required	undefined
mid	integer	Required	Format: int64.
eid	integer		Format: int64.
keySize	integer	Required	Format: int32.
keyState	string		undefined
exportable	boolean		undefined
createdDate	string		undefined
employeeId	integer		Format: int32.
modifiedDate	string		undefined
modifiedBy	integer		Format: int32.
keyData.wrappedRsaBytes	string		undefined
keyData.digitalSignature	string		undefined
keyData.initializationVector	string		IV may be required when you wrap with an AES key.
keyData.wrappedAesBytes	string		undefined

Status	Name	Type	Description
201			Encryption key is successfully imported
	keyName	string	undefined
	keyId	string	Format: GUID.
	keyVersion	integer	Format: int32.
	keyType	string	undefined
	mid	integer	Format: int64.
	eid	integer	Format: int64.
	keySize	integer	Format: int32.
	keyState	string	undefined
	exportable	boolean	undefined
	createdDate	string	undefined
	employeeId	integer	Format: int32.
	modifiedDate	string	undefined
	modifiedBy	integer	Format: int32.
	keyData.wrappedRsaBytes	string	undefined
	keyData.digitalSignature	string	undefined
	keyData.initializationVector	string	IV may be required when you wrap with an AES key.
	keyData.wrappedAesBytes	string	undefined

400			Invalid keystore provider name in the request header
	type	string	undefined
	title	string	undefined
	status	integer	Format: int32.
	detail	string	undefined
	instance	string	undefined
	additionalProperties	object	undefined

500			Unable to process request
	statusCode	integer	Format: int32.
	requestId	string	undefined
	message	string	undefined
	messageCode	string	undefined

503			System is unavailable to process request
	statusCode	integer	Format: int32.
	requestId	string	undefined
	message	string	undefined
	messageCode	string	undefined

Example Request

Example Response