GET /platform/v1/key/{keyId}

Fetches metadata for a specific key. Data at Rest Encryption is a prerequisite for this feature.

Name	Type		Description
keyId	string	Required	ID for the key to retrieve the metadata for.
x-request-id	string		Header parameter: Request ID for the request. Default Format: 06ef8c36-4a7a-4139-bdbd-c6715be06364.
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.

Status	Name	Type	Description
200			Key metadata successfully retrieved
	keyName	string	undefined
	keyId	string	format: uuid
	keyVersion	integer	Format: int32.
	keyType	string	undefined
	eid	integer	format: int64
	mid	integer	format: int64
	keySize	integer	Format: int32.
	keyState	string	undefined
	securityHash	string	format: byte
	keySignature	string	undefined
	keyStorageRepository	string	undefined
	createdDate	string	format: date-time
	createdBy	integer	Format: int32.
	modifiedDate	string	format: date-time
	modifiedBy	integer	Format: int32.
	keyData	string	undefined
	publicKeyData	string	undefined
	initializationVector	string	undefined
	keyDataWrappingKey	string	undefined
	isKeyDataWrapped	boolean	undefined
	exportable	boolean	undefined
	imported	boolean	undefined
	keyProviderIdentifier	string	undefined
	useCase	string	undefined
	keyOwnerId	integer	Format: int32.

400			Bad request, please see error details

404			Given Key Id is not found in metadata table (MemberKeyManagement)

500			Server error, unable to retrieve key metadata. Validate error logs in splunk

Example Request

Example Response