Support
 
Phone Live Chat
 
Support
 
US: +1 888 720 9500
US: +1 800 443 6694
Intl: +1 925 924 9500
Aus: +1 800 631 268
UK: 0800 028 6590
CN: +86 400 660 8680

Direct Inward Dialing: +1 408 916 9393

 
 
 
 
 
Create user
 

Create OU API

This API helps in creating user account in Active Directory from your application.

Request URL (JSON) Format: http:// : /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 - key/value pair of LDAP attributes and their corresponding values
AuthToken Yes Authentication token obtained using the Generate AuthToken API.
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 Request format:

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

Sample Response format:

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 CreateOU 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:

  • The default admin account will not be considered as a help desk technician.
  • Ensure that you URL encode all the special and reserved characters used in REST API requests. Since the client sending the request (browser, postman or TP tools) does not fall under ADManager Plus, encoding the URL for special, reserved and unsafe characters is solely the users' responsibility.

    Reserved characters include ; / ? : @ = &
    Unsafe characters include < > # % { } | \ ^ ~ [ ] ` "'

ADManager Plus Trusted By

The one-stop solution to Active Directory Management and Reporting
Email Download Link