Domain Configuration APIs


These APIs allow an admin user to perform domain configuration in Applications Manager. APIs are designed to support GET or POST requests:

Request Parameters

The parameters involved in executing this API request are:

Field Description
domainname * Name of the domain from which the users need to be imported.
domaincontroller * The hostname or the IP address of the DNS server for the domain.
domainport * The port of the DNS server.
service * OpenLDAP or Active Directory (AD)
permission The permission level for a domain. The possible values are:
  • 0 - Read Only - All users logged in through this domain will have read-only access.
  • 1 - Full Control - Users logged in will behave according to their roles specified.

Add Domain Configuration

This API allows an admin user to add a new domain in Applications Manager.

Syntax:

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller]&domainport=[ Domain Port]&service=[ Service ]&permission=[ Permission ]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/domain?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller]&domainport=[ Domain Port]&service=[ Service ]&permission=[ Permission ]

Example:

http://app-windows:59090/xml/AppManager/domain?apikey=16c220b3145cb34b1163cc81237e4fd0&domainname=csez.zohocorpin.com&domaincontroller=win2k8master.csez.zohocorpin.com&domainport=389&username=zohocorp\user-0596&service=AD&permission=1

Update Domain configuration

This API allows an admin user to edit the existing Domain controller settings added in Applications Manager.

Syntax

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller]&domainport=[ Domain Port]&service=[ Service ]&permission=[ Permission ]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/domain?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller]&domainport=[ Domain Port]&service=[ Service ]&permission=[ Permission ]

Example:

http://app-windows:59090/AppManager/xml/domain?apikey=16c220b3145cb34b1163cc81237e4fd0&domainname=csez.zohocorpin.com&domaincontroller=win2k8master.csez.zohocorpin.com&domainport=389&service=ad&permission=1

Delete Domain configuration

This API allows an admin user to delete domain configurations in Applications Manager.

Syntax

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain?apikey=[ API Key ]&domainname=[ Domain Name ]&TO_DELETE=[ True/False ]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/domain?apikey=[ API Key ]&domainname=[ Domain Name ]&TO_DELETE=[ True/False ]

Example:

http://app-windows:59090/AppManager/xml/domain?apikey=16c220b3145cb34b1163cc81237e4fd0&domainname=csez.zohocorpin.com&TO_DELETE=true

List Domain configuration

This API allows an admin user to list down the domains configured in Applications Manager.

Syntax

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain?apikey=[ API Key ]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/domain?apikey=[ API Key ]

Example:

http://app-windows:59090/AppManager/xml/domain?apikey=bfb8a60112560c40418e6f0bb37be874