Adding External CipherTrust Manager Domains

Use the post /v1/cckm/external-cm/add-domains API to add external CipherTrust Manager domains to the CipherTrust Manager. To add a domain, you need a connection to an external CipherTrust Manager and the domain ID.

Syntax

curl -k '<IP>/api/v1/cckm/external-cm/add-domains' -H 'Authorization: Bearer AUTHTOKEN' --compressed

Request Parameters

Parameter	Type	Description
AUTHTOKEN	string	Authorization token.
connection	string	Name or ID of the external CipherTrust Manager connection.
domains	array of strings	ID of the domain to be added. To add multiple domains, specify their IDs in the array. Refer to Getting External CipherTrust Manager Domains to get a domain's ID.

Example Request

curl -k 'https://127.0.0.1/api/v1/cckm/external-cm/add-domains' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjdiYzNkOWM4LWRiYTQtNDVmMy05YWNiLWI3NGM2MzQyYzYyMCIsImlhdCI6MTYxNDc1MTg1MSwiZXhwIjoxNjE0NzUyMTUxfQ.ahdxfM7-WA4u7sotHy6qelc9MkoZytst7oZWsvE7Cr0' -H 'Content-Type: application/json' --data-binary $'{\n  "connection": "cm-ext-connection",\n  "domains": ["0c78b1c9-486e-41fd-ad1d-b80912342073"]\n}' --compressed

Example Response

{
    "id": "0f1fb783-a25a-438f-ad5b-ee8759e73574",
    "uri": "kylo:kylo:cckm:externalcm-domain:0f1fb783-a25a-438f-ad5b-ee8759e73574",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2023-01-09T06:04:14.340614258Z",
    "updatedAt": "2023-01-09T06:04:14.340614344Z",
    "domains": [
        {
            "id": "2eb352a6-5049-413c-9939-7ee41d46a613",
            "uri": "kylo:kylo:cckm:externalcm-domain:2eb352a6-5049-413c-9939-7ee41d46a613",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2023-01-09T06:04:14.264291Z",
            "updatedAt": "2023-01-09T06:04:14.260823Z",
            "connection": "connection",
            "cm_domain": {
                "domain_id": "0c78b1c9-486e-41fd-ad1d-b80912342073",
                "domain_uri": "kylo:kylo:solo:domains:0c78b1c9-486e-41fd-ad1d-b80912342073",
                "account_uri": "kylo:kylo:admin:accounts:kylo",
                "domain_application": "ncryptify:gemalto:admin:apps:kylo",
                "domain_created_at": "2023-01-05 07:51:27.312078 +0000 UTC",
                "domain_name": "domain",
                "domain_updated_at": "2023-01-05 07:51:27.312078 +0000 UTC",
                "domain_meta": "",
                "zone_id": "ef583371-6a73-443c-9dc9-3013e7ed866d",
                "parent_domain_id": "00000000-0000-0000-0000-000000000000",
                "enable_syslog_redirection": true,
                "domain_account": "kylo:kylo-0c78b1c9-486e-41fd-ad1d-b80912342073:admin:accounts:kylo-0c78b1c9-486e-41fd-ad1d-b80912342073",
                "allow_user_management": false
            }
        }
    ]
}

The external CipherTrust Manager domain with ID 0c78b1c9-486e-41fd-ad1d-b80912342073 is added to CCKM. A unique resource ID (for example, 2eb352a6-5049-413c-9939-7ee41d46a613) is generated for the domain. This ID is required when viewing, updating, or deleting a particular domain from the CipherTrust Manager.

Response Codes

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

Refer to HTTP status codes for details.

Suggest A Change