Create External Key in SAP Keystore

Use the post /v1/cckm/sap/ekm/keys API to create external key for SAP HYOK, provide the following details.

The ID of the key store where external key will be hosted.
The name of the external key.
The Source Key type.
The ID of source key which material will be used.

Syntax

curl -k '<IP>/api/v1/cckm/sap/ekm/keys' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed

Request Parameters

Parameter	Type	Description
AUTHTOKEN	string	Authentication token.
keystore_id	string	ID of the key store where external key will be hosted.
name	string	Name for the external key.
source_key_identifier	string	Source Key Identifier of an existing CM source key. Supported key sizes are AES-256, RSA-3072, and RSA-4096.
source_key_tier	string	Source key-tier of an existing source key. Only 'local' source key tier is allowed.
description (optional)	string	Description for the sap external key.

Example Request

curl -k 'https://127.0.0.1/api/v1/cckm/sap/ekm/keys' -X POST -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlYmVjM2VkYi00YWExLTRkMzEtODNkMS05ZTI3YzI1ZjlkMTIiLCJzdWIiOiJsb2NhbHw5NWI3NmU3Yi0yNWE4LTQyYzYtYWFlNS01Yjg4NmI0NjA4MWUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImJlYWQ5ZGFkLWI2MmMtNDEzNi1iNjhiLTcwNTgyMjAyMTE3NyIsImlhdCI6MTcxMjIyOTcxMiwiZXhwIjoxNzEyMjMwMDEyfQ.gHTB5P1GYQznVpyqvHFhH3-Px9kwFSZFtOhQqRiseSiARLyOWcmB05sz9sBCG5oFT_h_P00K5FuyKi7GoTCghA' -H 'accept: application/json' --compressed

Example Response

{
    "id": "abbccb49-33aa-4f2e-b2bb-92ba821adb60",
    "uri": "kylo:kylo:cckm:sap-key:sapekmkey-abbccb49-33aa-4f2e-b2bb-92ba821adb60",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2024-03-15T10:07:13.676645Z",
    "updatedAt": "2024-03-15T10:07:13.671552Z",
    "name": "SAPEKMKey",
    "cloud_name": "sap",
    "description": "This is sap external key",
    "keystore_id": "edafcd7d-a40a-4da6-86a7-e76fdf768632",
    "size": 256,
    "state": "Enabled",
    "algorithm": "AES",
    "sap_tenant_id": "edafcd56d-a40a-4da6-84a7-e76fdf768456",
    "source_key_tier": "local",
    "blocked": false,
    "auto_rotate": false,
    "version_count": 1,
    "version_id": "0397e4ed-d653-4329-811a-af84ab81f6c0"
}

Response Codes

Response Code	Description
2xx	Success
4xx	Client errors
5xx	Server errors

Refer to HTTP status codes for details.

Create External Key in SAP Keystore

Syntax

Request Parameters

Example Request

Example Response

Response Codes

On this page

Suggest A Change