Direct Inward Dialing: +1 408 916 9393
Use this API to move a user in Active Directory from your application.
Request URL format: http://<hostname>:<port>/RestAPI/MoveUser
Request parameters:
Parameter name | Mandatory | Description |
PRODUCT_NAME | Yes | Product name or 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 | Name of the domain in which the user accounts are present. |
inputFormat | Yes | Details of each user account to be moved. This attribute should be a JSONArray string and must be in the format mentioned below:
[<JSONObject>, <JSONObject>, <JSONObject>]; JSONObject: The key/value pair of LDAP attributes and the values.
NOTE: You can specify any of the following attributes as search criteria to locate user objects using REST API requests: sAMAccountName, UserPrincipalName, distinguishedName, mail, employeeID, objectGUID and objectSID |
targetOU | Yes | The name of the OU to which the users are being moved. |
Response:
The response will be a JSON array string which contains the list of JSONObjects.
Parameter name | Description |
destinationOUName | Name of the OU to which the users are being moved. |
sAMAccountName | sAMAccountName of the user. |
objectGUID | objectGUID of the user. |
objectSID | objectSID of the user. |
distinguishedName | distinguishedName of the user. |
userPrincipalName | userPrincipalName of the user. |
ouName | Name of the container from where the user is moved. |
statusMessage | Contains the appropriate message if an issue or error occurs while processing the request. |
status | Contains 1 or 0, indicating whether the operation is a success or failure. |
Sample input/output:
Request
http://admanager:8080/RestAPI/MoveUser?AuthToken=3187f9d3-da6b-4bc2-aaff-a73495753b8d&PRODUCT_NAME=MODULE_NAME&domainName=test.com&inputFormat=[{sAMAccountName:Alex}]&targetOU=OU=RealUser,DC=test,DC=com
Response:
[ { "destinationOUName": "OU=RealUser,DC=test,DC=com", "sAMAccountName": "Alex", "objectGUID": "{382CB201-0F7A-48C7-9C0B-2EE1C1FA2F3C}", "objectSID": "S-1-5-21-2058198098-2931619084-4035890149-7533", "distinguishedName":"CN=Alex,OU=Users,DC=test,DC=com", "userPrincipalName": "alex@test.com", "ouName": "OU=Users,DC=test,DC=com", "statusMessage": "Successfully moved the user to specified container.", "status": "1" } ]