Direct Inward Dialing: +1 408 916 9393
Free EditionThis API can be used to reset the Active Directory password of a user account.
Request URL (JSON) format: http://<hostname>:<port>/RestAPI/ResetPwd
Request parameters:
| Parameter Name | 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 obtained using the Generate AuthToken API. |
| domainName | Yes | Domain name of the user. |
| pwd | Yes | New password for the user. |
| inputFormat | Yes | Details of each user account whose password has to be reset. This attribute should be a JSONArray string and should be in the format mentioned below. |
| [<JSONObject>, <JSONObject>, <JSONObject>]; JSONObject - 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 containing 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 account |
| sAMAccountName | sAMAccountName of the user account |
| objectSID | objectSID of the user account |
| statusMessage | Contains appropriate error message about the issues/errors that occurred while processing the request. |
Sample Input / Output
Request:
http://Byron:8080/RestAPI/ResetPwd?AuthToken=a70d9e6c-4167-4de4-a6a1-3b3aff50c82e&PRODUCT_NAME=MODULE_NAME&domainName=admanagerplus.com&pwd=Test@123&inputFormat=[{"sAMAccountName":"colin.altonen"},{"sAMAccountName":"Coleman"}]
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."},{"userPrincipalName":"Coleman@admanagerplus.COM","sAMAccountName":"Col eman","objectSID":"S-1-5-21-2996321955-1937665885-1535019402-3712","objectGUID":"{B6 EBC9F3-703E-43F4-BAF9-FC785E34099D}","distinguishedName":"CN=Coleman,OU=test,D C=admanagerplus,DC=COM","statusMessage":"Successfully modified."}]
Technician-based password reset limit
The total number of users' passwords that technicians can reset in a day using the ResetPwd API depends on the total number of licensed help desk technicians (HDTs).
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, that is 2*50.
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 < > # % { } | \ ^ ~ [ ] ` "'
