Fetching Metadata of all Versions of a Key
Use the post /v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/get-versions-metadata API to retrieve the metadata of all the versions of a key on CipherTrust Manager. The response payload includes list of key versions with supported cryptographic operations (encrypt, decrypt, sign, or verify).
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 Data Custodian KMS to correlate SAP audit record with CipherTrust Manager audit records. |
| skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. The default value is 0. |
| limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. The default value is 10. |
| key_version_id | string | The ID of the key version. |
| created_after | string | The time when the key version was created. |
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"
}
"skip": 0,
"limit": 10,
"key_version_id": "6f4fc7c4-6110-4327-8fa1- 68266217803e",
"created_after": "2024-12-02T05:37:34.102591Z"
}
Example Response
{
"skip": 0,
"limit": 10,
"total": 1,
"resources":
{
"id": "6f4fc7c4-6110-4327-8fa1- 68266217803e",
"created_at": "2024-12-02T05:37:34.102593Z"
}
}
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.
