Viewing DSM Domains
Use the get /v1/cckm/dsm/domains
API to view the list of DSM domains added to the CipherTrust Manager.
Syntax
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | ID of the DSM domain resource on the CipherTrust Manager, for example, 83d7b91f-2298-420e-b7a5-ce0dce07a6d9 . Note that this ID is different than the domain ID on DSM, for example, 1385 . Refer to Adding DSM Domains to find out the resource ID of a domain. |
name | string | Name of the domain. |
connection | string | Name or ID of the DSM connection. |
adminType | string | Type of the DSM administrator linked with the domain. The type can be: • SYSTEM_ADMIN • DOMAIN_ADMIN • SECURITY_ADMIN • SECURITY_AND_DOMAIN_ADMIN • ALL_ADMIN |
kmipEnabled | boolean | Whether KMIP is enabled on the domain - true or false . |
fingerprintRegistrationDisabled | boolean | Whether fingerprint registration is disabled on the domain - true or false . |
registrationTokenEnabled | boolean | Whether registration tokens are enabled on the domain - true or false . |
hosts | array of strings | List of DSM host IP addresses. |
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
Example Response
The output shows the list of DSM 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.