Direct Inward Dialing: +1 408 916 9393
Free EditionThis API helps fetch details of domains configured in ADManager Plus
Request URL (JSON) format: http://<hostname>:<port>/RestAPI/GetDomainList
Request parameters:
Following are the request parameters that can be used in the request:
| Parameter name | Mandatory | Description |
| PRODUCT_NAME | Yes | Product name/module name from which the request is being sent; will be needed for auditing. |
| AuthToken | Yes | Authentication token that is generated either from the Delegation tab (Delegation > Configuration > Technician Authtokens) or from the My account tab (My Account > Active Authtokens) in the top right corner of the product. |
| domainName | Optional (If not given, it will return all the configured domain details) | The domain name for which details need to be retrieved. |
Response:
The response will be a JSON array string which contains the list of JSON objects. Each JSON object in the list represents the domains configured in ADManager Plus. Each object will contain the following properties.
| Parameter Name | Description |
| domainList | Requested domain details |
| status | 0 or 1, where 1 means success and 0 means failed |
| statusMessage | Contains the appropriate message if an issue/error occurs while processing the request. |
Sample Input / Output
Request:
http://admanager:8080/RestAPI/GetDomainList?AuthToken=07dcd0c9-3d7c-42d6-b26b-cdzcsdzcsdzdszv&PRODUCT_NAME=RestAPI
Response:
{"domainList":[{"userName":"Admanager","domainFlatName":"ADMANAGER","domainDisplayName":"admanager.com"},{"domainFlatName":"DOMAINTEST","domainDisplayName":"domaintest.com"}],"statusMessage":"SUCCESS","status":1}
Note:
Reserved characters include ; /? : @ = &
Unsafe characters include < > # % { } | \ ^ ~ [ ] ` "'
