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 user API

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

Request URL (JSON) Format: http://<hostname>:<port>/RestAPI/CreateUser

Request Parameters

Parameter Name Mandatory Description
AuthToken Yes Authentication token obtained using the Generate AuthToken API.
domainName Yes Domain in which the user object has to be created
inputFormat Yes Details of the attributes of user accounts to be created. This attribute should be a JSONArray string and should be in the format mentioned below.
[>, <JSONObject>, <JSONObject>]; JSONObject - key/value pair of LDAP attributes and their corresponding values

Sample code in java: JSONArray userDetails = new JSONArray(); JSONObject json = new JSONObject(); json.put("givenName", "John"); json.put("initials", "mat"); json.put("sn", "Martin"); json.put("password", "Martin@12"); json.put("templateName", "User Creation Template"); userDetails.put(json); json = new JSONObject(); json.put("givenName", "Damien"); json.put("initials", "S"); json.put("sn", "David"); json.put("password", "Test@123"); json.put("templateName", "User Creation Template"); userDetails.put(json);

Note: If the "templateName" attribute is not included in the key/value pair, the default user creation template assigned for the technician will be used.
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 a user 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 user 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.
LOG_ON_NAME Logon name of the user account created. Will be present only if the user creation operation is successful.
USER_NAME User name of the user account created. Will be present only if the user creation operation is successful.
USER_PASSWORD Password of the user account created, in plain text. Will be present only if the user creation operation is successful.

Sample Input / Output

Request:

http://Byron:8080/RestAPI/CreateUser?domainName=admanagerplus.com&AuthToken=a70d9e6c-4167-4de4-a6a1-3b3aff50c82e&PRODUCT_NAME=MODULE_NAME&inputFormat=[{"givenName":"ByronTest", "password":"Test@123", "templateName":"User Creation Template"}]

Response:

[{"status":"SUCCESS","LOG_ON_NAME":"ByronTest","USER_NAME":"ByronTest","USER_P ASSWORD":"Test@123","statusMessage":"Successfully created the user."}]

Authorization:

When technicians send API requests, their authorization will be applied to those requests. That is, if a technician is not authorized to create user, the technician cannot create user accounts using the API either.

Technician-based user creation limit.

The total number of users that can be created in a day using the CreateUser API now depends on the total number of licensed help desk technicians (HDTs).

Click here to refer table for the specific details.

×
HDT Count API Count
1 to 5 5
6 to 10 10
11 to 50 20
51 to 100 50
>=100 100

The following formula explains the total number of users that can be created in a day by licensed technicians:

Total users created in a day =Total no. of HDTs * API count for that technician range.

That is, if there are four licensed technicians in ADManager Plus, then the total number of users that can be created are twenty per day (4 technicians * 5 API count = 20 users/day). If needed, any single technician can create all the twenty users.

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