Direct Inward Dialing: +1 408 916 9393
Free EditionThis API helps you raise a workflow request for password resets of users from your application.
Request URL (JSON) Format: http://<hostname>:<port>/RestAPI/CreateWorkFlowRequest
Request Parameters
| Parameters | Mandatory | Description |
| 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 in which this operation has to be performed. |
| inputData | Details about the workflow request to be raised. It must also contain the user accounts whose passwords have to be reset through the workflow request. | |
| Yes | Specify the title of the request under Subject. | |
| Yes | Specify the action as RESET_PASSWORD under RequestAction. | |
| Yes | Specify the user accounts whose passwords have to be reset. | |
| Optional | Specify the priority of the task. | |
| Optional | Provide a suitable Description. | |
| Yes | Enter the PasswordType as generatePassword for generating a random password, and ownPassword for specifying the password. The random password is generated according to the configured password policy. |
|
| Optional* | Enter the Password, and the true or false values of properties like UserMustChangePwd, CantChangePwd, and PwdNeverExpires. | |
| PRODUCT_NAME | Yes | Product name/module name from which the request is being sent; will be needed for auditing. |
*The Password attribute is optional only if the PasswordType attribute value is generatePassword.
Response Parameters:
| Parameters | Description |
| Subject | Subject of the request |
| requestId | RequestId of the request raised. This is not displayed in the response, if the operation has failed. |
| status | Status of the operation, where 1 stands for Success and 0 stands for Failure. |
| statusMessage | The response message to be displayed in case of success or failure. |
Sample Input / Output
Request:
http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"RESET_PASSWORD", "Subject":"Reset password", "Description":"desc", "priority":"2",
"PasswordType":"ownPassword","Password":"Admp@123","UserMustChangePwd"
:"true","PwdNeverExpires":"false", "CantChangePwd":"false", "accounts":[{"sAMAccountName":"john"}]}]
Response:
[{"Subject":"Reset password","requestId":4801,"statusMessage":"Successfully created the request.","status":"1"}]
