Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

SAP Invoked APIs

Fetching the Key Metadata

search

Please Note:

printsuggest an editpdf paneldownload

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.

copy link to clipboardRequest Parameters

ParameterTypeDescription
sap_tenant_idstringID of the SAP Tenant.
sap_group_id (optional)stringID of the SAP Group .
sap_user_type (optional)stringType of the SAP user.
sap_request_id (optional)stringRequest ID of the call made to SAP DC KMS to correlate SAP audit record with Thales CM audit record.

copy link to clipboardExample 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"
    }
}

copy link to clipboardExample 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"
}

copy link to clipboardResponse Codes

Response CodeDescription
200Ok
400Bad request
401Unauthorized
404Not found
403Forbidden
500Internal server error

Refer to HTTP status codes for details.

On this page