Direct Inward Dialing: +1 408 916 9393
Free EditionThis API can be used to unlock any user account in Active Directory.
Request URL (JSON) format: http://<hostname>:<port>/RestAPI/UnlockUser
Request parameters:
| Parameter Name Is | 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 | Yes | Domain name of the user accounts. |
| inputFormat | Yes |
Details of each user account to be unlocked. This attribute should be a JSONArray string and must be in format mentioned below. [<JSONObject>, <JSONObject>, <JSONObject>]; JSONObject: The key/value pair of LDAP attributes and the values. Sample code in java: JSONArray userDetails = new JSONArray(); JSONObject json = new JSONObject(); json.put("sAMAccountName", "John"); userDetails.put(json); json = new JSONObject(); json.put("sAMAccountName", "Mat"); userDetails.put(json); NOTE: You can specify any of the following attributes as search criteria to locate user objects using REST API requests:
|
Response:
The response will be a JSONArray string which contains the list of JSONObjects. Each JSONObject in the list represents a user account sent in the inputFormat parameter in the request. Each object will contain the following properties.
| Parameter Name | Description |
| userPrincipalName | userPrincipalName of the user. |
| sAMAccountName | sAMAccountName of the user. |
| objectSID | objectSID of the user. |
| statusMessage | Contains the appropriate message if an issues/error occurs while processing the request. |
Sample Input / Output
Request:
http://Byron:8080/RestAPI/UnlockUser?AuthToken=a70d9e6c-4167-4de4-a6a1-3b3aff50c82e&PRODUCT_NAME=MODULE_NAME&domainName=admanagerplus.com&inputFormat=[{"sAMAccountName":"colin.altonen"}]
Response:
[{"userPrincipalName":"colin.altonen@admanagerplus.COM","sAMAccountName":"colin.alton en","objectSID":"S-1-5-21-2996321955-1937665885-1535019402-3712","objectGUID":"{B6EB C9F3-703E-43F4-BAF9-FC785E34099D}","distinguishedName":"CN=colin.altonen,OU=test,D C=admanagerplus,DC=COM","statusMessage":"Successfully modified."}]
Technician-based unlock users limit
The total number of user accounts that technicians can unlock in a day using the unlock user 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 < > # % { } | \ ^ ~ [ ] ` "'
