Fetching the Key Metadata
The post /v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/get-metadata API retrieves the metadata associated with a key stored in a keystore on CipherTrust Manager. The response payload includes key specification, supported cryptographic operations (encrypt, decrypt, sign, or verify), and latest version identifier and state.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| sap_tenant_id | string | ID of the SAP Tenant. |
| sap_group_id (optional) | string | ID of the SAP Group . |
| sap_user_type (optional) | string | Type of the SAP user. |
| sap_request_id (optional) | string | Request ID of the call made to SAP DC KMS to correlate SAP audit record with Thales CM audit record. |
Example Request
post https://<Host IP Address>/api/v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/get-metadata
<authorization token and other headers>
{
"request_metadata": {
"sap_tenant_id": "5e3d1d87-9502-42af-a946-3ffec9e71a44",
"sap_group_id": "0dab7383-fa9b-4540-bcc7-fe03a6f59487",
"sap_user_type": "USER_DEV",
"sap_request_id": "86428acc-a1c8-6de1-b8f7-8de9a436gdr3"
}
}
Example Response
{
"key_id": "e9e78471-297f-46b3-89e3-a8c5980afda9",
"key_version_id": "0dab7383-fa9b-4540-bcc7-fe03a6f59487",
"state": "Enabled",
"key_ops": [
"ENCRYPT",
"DECRYPT"
],
"key_spec": "AES_256"
}
Response Codes
| Response Code | Description |
|---|---|
| 200 | Ok |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Not found |
| 403 | Forbidden |
| 500 | Internal server error |
Refer to HTTP status codes for details.
