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

Move User API

Move User API

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.
Example JSONArray:

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.


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:




  "destinationOUName": "OU=RealUser,DC=test,DC=com",
  "sAMAccountName": "Alex",
  "objectGUID": "{382CB201-0F7A-48C7-9C0B-2EE1C1FA2F3C}",
  "objectSID": "S-1-5-21-2058198098-2931619084-4035890149-7533", 
  "userPrincipalName": "", 
  "ouName": "OU=Users,DC=test,DC=com",
  "statusMessage": "Successfully moved the user to specified container.", 
  "status": "1" } 

ADManager Plus Trusted By

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