Viewing External CipherTrust Manager Domains
Use the get /v1/cckm/external-cm/domains
API to view the list of external CipherTrust Manager domains added to the CipherTrust Manager.
Syntax
curl -k '<IP>/api/v1/cckm/external-cm/domains' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | ID of the external CipherTrust Manager domain resource on the CipherTrust Manager, for example, 83d7b91f-2298-420e-b7a5-ce0dce07a6d9 . Note that this ID is different than the domain ID on external CipherTrust Manager, for example, 1385 . Refer to Adding External CipherTrust Manager Domains to find out the resource ID of a domain. |
connection | string | Name or ID of the external CipherTrust Manager connection. |
domain_name | string | Name of the domain. |
parent_domain_id | string | ID of the parent domain. |
enable_syslog_redirection | boolean | Whether log redirection to a Syslog server is enabled. Set to true to enable, false to disable. |
allow_user_management | boolean | Whether user management is allowed. Set to true to allow, false to deny. |
skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
sort | string | Comma-delimited list of properties to sort the results. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/external-cm/domains?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjdiYzNkOWM4LWRiYTQtNDVmMy05YWNiLWI3NGM2MzQyYzYyMCIsImlhdCI6MTYxNDc1MTg1MSwiZXhwIjoxNjE0NzUyMTUxfQ.ahdxfM7-WA4u7sotHy6qelc9MkoZytst7oZWsvE7Cr0' --compressed
Example Response
{
"skip": 0,
"limit": 10,
"total": 2,
"resources": [
{
"id": "1aa1a599-137e-4cf2-b2b2-f0686129c501",
"uri": "kylo:kylo:cckm:externalcm-domain:1aa1a599-137e-4cf2-b2b2-f0686129c501",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2023-01-09T06:04:14.314024Z",
"updatedAt": "2023-01-09T06:04:14.311851Z",
"connection": "connection",
"cm_domain": {
"domain_id": "dfced667-0977-4d58-813e-ae26ec49336c",
"domain_uri": "kylo:kylo:solo:domains:dfced667-0977-4d58-813e-ae26ec49336c",
"account_uri": "kylo:kylo:admin:accounts:kylo",
"domain_application": "ncryptify:gemalto:admin:apps:kylo",
"domain_created_at": "2023-01-05 12:18:30.3969 +0000 UTC",
"domain_name": "domain2",
"domain_updated_at": "2023-01-05 12:18:30.3969 +0000 UTC",
"domain_meta": "",
"zone_id": "e20cd1bb-57fd-418a-aab5-4ec4f045b90b",
"parent_domain_id": "00000000-0000-0000-0000-000000000000",
"enable_syslog_redirection": true,
"domain_account": "kylo:kylo-dfced667-0977-4d58-813e-ae26ec49336c:admin:accounts:kylo-dfced667-0977-4d58-813e-ae26ec49336c",
"allow_user_management": false
}
},
{
"id": "a9fe1639-5d7f-41a0-8779-110483e49695",
"uri": "kylo:kylo:cckm:externalcm-domain:a9fe1639-5d7f-41a0-8779-110483e49695",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2023-01-09T06:04:14.287725Z",
"updatedAt": "2023-01-09T06:04:14.286604Z",
"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 output shows the list of external CipherTrust Manager domains available on the CipherTrust Manager.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.