This operation updates a domain.
Request
Syntax
Send the request using either XML or JSON:
-
XML
POST <webservice>/CommCell/DomainController HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml <update_domain.xml>
-
JSON
POST <webservice>/CommCell/DomainController HTTP/1.1 Host: <host name> Accept: application/json Authtoken: <authentication token> Content-type: application/json <update_domain.json>
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 Web Console 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. |
|
Content-type |
The media type contained in the request body. |
Request Body
Download the XML or JSON file required for this request: update_domain.xml or update_domain.json. The following table displays the parameters for the request body.
|
Name |
Description |
Elements |
|
operationType |
Valid value is 3. |
EVGui_UMDSProviderOpsReq |
|
serviceType |
The type of domain controller. Valid values are:
|
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: If you send a JSON request, the password or secret must be Base64 encoded. |
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 |
|
clientId |
The system-generated ID assigned to the client. |
adProxyList |
|
_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 |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
errorCode |
The possible error codes. Valid values are:
|
CVGui_GenericResp |
|
errorMessage |
The description of the error code. Not all error codes have an error message. |
CVGui_GenericResp |
Examples
Sample Request
XML
POST <webservice>/CommCell/DomainController HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<EVGui_UMDSProviderOpsReq operation="3"> <provider connectName="testAD001" login="admin" bLogin="admin" bPassword="PlainTextPassword" flags="0" enabled="0" serviceType="2" useSecureLdap="1"> <shortName id="1" domainName="mycompany"/> </provider>
</EVGui_UMDSProviderOpsReq>
JSON
POST <webservice>/CommCell/DomainController HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
{ "operation": 3, "provider": { "serviceType": 2, "flags": 0, "bPassword": "YmFzZTY0RW5jb2RlZFBhc3N3b3Jk", "login": "admin", "enabled": 1, "useSecureLdap": 1, "connectName": "testAD001", "bLogin": "admin" }, "shortName": { "domainName": "mycompany", "id": 1 }
}
Sample Response
{ "errorMessage": "", "errorCode": 0
}