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 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 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 Input / Output

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"}}]

Note:

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

Response:

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

Modify user by template API

ADManager Plus Trusted By