Direct Inward Dialing: +1 408 916 9393
Free EditionThis API helps in creating OU in Active Directory from your application.
Request URL (JSON) Format: http://<hostname>:<port>/RestAPI/CreateOU
Request Parameters
| Parameter Name | Mandatory | Description |
| domainName | Yes | Name of the domain in which the OU has to be created. |
| inputFormat | Yes | Details of the attributes of OUs to be created. This attribute should be a JSONArray string and should be in the format mentioned below. [<JSONObject>, <JSONObject>, <JSONObject>]; JSONObject: The key/value pair of LDAP attributes and the values. |
| 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. |
| PRODUCT_NAME | Yes | Product name/module name from which the request is being sent; will be needed for auditing. |
Response:
The response will be a JSON array string which contains the list of JSONObjects. Each JSONObject in the list represents an object sent in the inputFormat attribute in the request. Each object will contain the following properties about the status.
| Parameter Name | Description |
| status | Status of the OU creation operation. 'SUCCESS' on successful creation. 'SEVERE' if there is an error. |
| statusMessage | Contains the message about the issues or errors that occur while performing the specified action. |
| USER_NAME | Name of the OU created. Will be present only if OU creation is successful. |
Sample Input / Output
Request:
http://admanager:8080/RestAPI/CreateOU?AuthToken=ac2d6090-11d0-4028-a2d5-f38a7930912e&domainName=mse1.com&inputFormat=[{"name":"testBOU5", "OUName":"OU=test,DC=mse1,DC=com"}]&PRODUCT_NAME=RESTAPI
Response:
[{"USER_NAME":"testBOU5","LOG_ON_NAME":"","statusMessage":"Successfully created the OUs.","status":"SUCCESS"}]
Technician-based OU creation limit
The total number of OUs that can be created in a day using the create OU API depends on the total number of licensed help desk technicians (HDTs).
If an API is used to create five AD users, and three of them are successfully created while two fail, it will be considered as three API calls. The maximum number of API calls that an HDT can make is 50/day, irrespective of the tasks that the HDT performs. If you have two HDT licenses, the total number of API calls that you can make is 100/day.
As the per day API call limit is not task-specific, you can perform any operation but the total number of API calls should not exceed 100. That is, an HDTcan perform a variety of operations like user creation, OU creation, password reset, etc., but the number of API calls for all the tasks put together should not exceed 100.
Note:
Reserved characters include ; / ? : @ = &
Unsafe characters include < > # % { } | \ ^ ~ [ ] ` "'
