Changing Connection of an External CipherTrust Manager Domain
Use the patch /v1/cckm/external-cm/domains/{id} API to change the connection of an external CipherTrust Manager domain. The connection must have appropriate access permissions on the domain.
Syntax
curl -k '<IP>/api/v1/cckm/external-cm/domains/{id}' -X PATCH -H 'Authorization: Bearer AUTHTOKEN' -H --compressed
Here, {id} represents the ID of the external CipherTrust Manager domain resource on the CipherTrust Manager. Refer to Adding External CipherTrust Manager Domains to find out the resource ID of a domain.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
| connection | string | Name or ID of the new external CipherTrust Manager connection. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/external-cm/domains/d6bebc8c-974f-4ea0-9118-3726e835b734' -X PATCH -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImFkYzNiZGQ4LTQ3YmItNGY0Zi05YzJkLWU0ODExOGE3YWI0NiIsImlhdCI6MTYxNDc1MjQzOCwiZXhwIjoxNjE0NzUyNzM4fQ.6S9ae8ESCkT6-aOd3vX2fdtq_jG1kUn6TWthrr9ZVms' -H 'Content-Type: application/json' --data-binary $'{\n "connection": "new-connection"\n}' --compressed
Example Response
{
"id": "d6bebc8c-974f-4ea0-9118-3726e835b734",
"uri": "kylo:kylo:cckm:external-cm-domain:d6bebc8c-974f-4ea0-9118-3726e835b734",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2023-01-10T15:13:20.650149Z",
"updatedAt": "2023-01-11T14:09:02.053797Z",
"connection": "updated-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 output shows the updated description and new external CipherTrust Manager domain new-connection.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
