Fetching the Keystore Metadata
The post /v1/cckm/sap/hyok/v1/keystores/{keystore_id}/get-metadata API retrieves the metadata associated with a keystore on CipherTrust Manager. The response payload includes keystore ID, SAP tenant ID, 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}/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
{
"keystore_id": "ab32899e-ae46-4495-b55f-23fb88cded7f",
"sap_tenant_id": "5e3d1d87-9502-42af-a946-3ffec9e71a44",
"state": "ACTIVE"
}
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.
