REST API - GET Domain

This operation returns a list of domains registered with the CommServe computer.

Request

Syntax

GET webservice/CommCell/DomainController HTTP/1.1
Host: host name
Accept: application/xml | application/json
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Name	Description	Elements
serviceType	The type of domain controller. Valid values are: 2, Active Directory services 7, RADIUS server	providers
flags		providers
description	The description for the domain controller.	providers
login	The user name for the domain user account. The user account must have at least read access to the domain.	providers
enabled	The option to enable or disable the domain controller. Valid values are 0/1.	providers
trustedHostUser	The user name for the domain user account. The user account must have at least read access to the domain.	providers
password	The password for the domain user account. If your domain is a RADIUS server, this is the server secret located in the RADIUS installation location in the clients.conf file. Important: This value is encrypted and cannot be used in the POST Domain Controller API.	providers
bTrustedHostUser		providers
useSecureLdap	The option to enable the secure Lightweight Directory Access Protocol (LDAP) for additional network security with the external domain. Important: This can only be enabled when the external domain is configured to use the secure LDAP. If this protocol is enabled in the CommCell environment, but not configured from the external domain, the feature is not enabled. Valid values are 0/1.	providers
connectName	The fully qualified domain name (FQDN), for example, domain.company.com. If the useSecureLdap parameter is set to 1, the domain name is the name of the domain controller, for example, host.domain.company.com.	providers
port	The port used by the domain controller.	providers
bLogin		providers
enable	The option to use a client computer as a proxy to connect to a remote domain controller. Valid values are 0/1.	tppm
tppmType	Valid value is 4.	tppm
portNumber		proxyInformation
clientName	The name of the client to use as a proxy to access the domain controller.	proxyEntity
clientId	The system-generated ID assigned to the client.	proxyEntity
_type_		proxyEntity
domainName	The name of the Active Directory Resource domain. Users in the Admin domain can access the resources in the Resource domain. (The Admin domain contains the user credentials for all users. The Resource domain includes the resources or applications that can be accessed by each user in the Admin domain.)	resourceProvider
id	The system-generated ID assigned to the resource domain.	resourceProvider
domainName	The NetBIOS name of the domain, for example, mydomain.	shortName
id	The system-generated ID assigned to the domain.	shortName

Examples

Sample Request

GET webservice/CommCell/DomainController HTTP/1.1
Host: client.mydomain.com
Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{  "providers": [{  "serviceType": 2,  "flags": 1,  "description": "",  "login": "admin001",  "enabled": 1,  "trustedHostUser": "admin001",  "password": "3fc6a1ae5e2a31de47e4188b439590b5f614fad96bf545daa",  "bTrustedHostUser": "",  "useSecureLdap": 0,  "connectName": "abc.mycompnay.com",  "port": 0,  "bLogin": "admin001",  "tppm": {  "enable": false,  "tppmType": 4,  "proxyInformation": {  "portNumber": 0,  "proxyEntity": {  "clientName": "0",  "clientId": 0,  "_type_": 3  }  }  },  "resourceProvider": {  "domainName": "myresource",  "id": 0  },  "shortName": {  "domainName": "mycompany",  "id": 1  }  }]
}