Phone Live Chat
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

Modify user

Modify user by template API

This API helps you raise a workflow request for Modify User by Template operation from your application.

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

Request Parameters:

Parameter Name Mandatory Description
AuthToken Yes Authentication token obtained using the Generate AuthToken API.
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 attributes of the user accounts to be modified via templates through the workflow request.
Yes Specify the title of the request under Subject.
Yes Specify the action as MODIFY_USER under RequestAction.
Yes Specify the user account to be modified.
Optional Specify the priority of the task.
Optional Specify the Description of the task.
PRODUCT_NAME Yes Product name/module name from which the request is being sent; will be needed for auditing.

Response Parameters:

Parameter 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 Request

http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"MODIFY_USER", "Subject":"Modify User by Template", "accounts":{"givenName":"john", "password":"Test@123", "templateName":"M1"}}]

  1. As of now, this API supports only one user at a time. So the account parameter should be an object instead of an array.
  2. The System Template will be selected automatically, if the template name is not specified in the request.

Sample Response:

[{"Subject":"Modify User by Template","requestId":10529,"statusMessage":"Successfully created the request.","status":"1"}]

ADManager Plus Trusted By

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