GET /platform/v1/key/{keyId}

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

NameTypeDescription
keyIdstringRequiredID for the key to retrieve the metadata for.
x-request-idstringHeader parameter: Request ID for the request. Default Format: 06ef8c36-4a7a-4139-bdbd-c6715be06364.
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.
StatusNameTypeDescription
200  Key metadata successfully retrieved
 keyNamestringundefined
 keyIdstringformat: uuid
 keyVersionintegerFormat: int32.
 keyTypestringundefined
 eidintegerformat: int64
 midintegerformat: int64
 keySizeintegerFormat: int32.
 keyStatestringundefined
 securityHashstringformat: byte
 keySignaturestringundefined
 keyStorageRepositorystringundefined
 createdDatestringformat: date-time
 createdByintegerFormat: int32.
 modifiedDatestringformat: date-time
 modifiedByintegerFormat: int32.
 keyDatastringundefined
 publicKeyDatastringundefined
 initializationVectorstringundefined
 keyDataWrappingKeystringundefined
 isKeyDataWrappedbooleanundefined
 exportablebooleanundefined
 importedbooleanundefined
 keyProviderIdentifierstringundefined
 useCasestringundefined
 keyOwnerIdintegerFormat: 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

Usage

Example Request

Example Response