Direct Inward Dialing: +1 408 916 9393
Free EditionThis API helps you raise a workflow request to remove users from AD groups using 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 details about the user and the group from which it has to be removed. | |
| Yes | Specify the title of the request under Subject. | |
| Yes | Specify the action as REMOVE_USERS_FROM_GROUP under RequestAction. | |
| Yes | Specify the user accounts to be removed from a group or groups. | |
| Optional | Specify the priority of the task. | |
| Optional | Provide a suitable Description. | |
| Yes | Enter the sAMAccountName of the groups from which the users have to be removed. | |
| Optional | Specify whether the users must be removed from all groups using the isRemoveAllGroup attribute. If isRemoveAllGroup attribute value is true, then the sAMAccountName of all the groups need not be specified. | |
| PRODUCT_NAME | Yes | Product name/module name from which the request is being sent; will be needed for auditing. |
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 1:
http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"REMOVE_USERS_FROM_GROUP", "Subject":"Remove From Group", "accounts":[{"sAMAccountName":"john"}], "isRemoveAllGroup":"true"}]
Request 2:
http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"REMOVE_USERS_FROM_GROUP", "Subject":"Remove From Group", "accounts":[{"sAMAccountName":"john"}], "isRemoveAllGroup":"false", "groups":[{"sAMAccountName":"manager"}]}]
Response:
[{"Subject":"Remove From Group","requestId":6307,"statusMessage":"Successfully created the request.","status":"1"}]
