Add computers to groups API

This API helps in adding computer objects to an Active Directory group from your application.

Request URL format: http://<hostname>:<port>/RestAPI/AddComputersToGroup

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 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	Name of the domain in which the computer accounts are present.
inputFormat	Yes	Details of each computer account to be modified. 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: [{"sAMAccountName":"Test-Computer-1$"}, {"sAMAccountName":"Test-Computer-2$"}] NOTE: You can specify any of the following attributes as search criteria to locate computer objects using REST API requests: sAMAccountName, distinguishedName, objectGUID and objectSID
addGroup	No	List of all sAMAccountName of the groups.
primaryGroup	No	sAMAccountName of the primary group.
objectType	No	To set the object type to computer.

Response:

The response will be a JSON array string which contains the list of JSONObjects.

Parameter name	Description
sAMAccountName	sAMAccountName of the computer.
objectGUID	objectGUID of the computer.
objectSID	objectSID of the computer.
userPrincipalName	Name of the computer.
ouName	Name of the container where the computer to be added is located.
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/AddComputersToGroup?PRODUCT_NAME=MODULE&AuthToken=3187f9d3-da6b-4bc2-aaff-a73495753b8d&domainName=test.com&inputFormat=[{sAMAccountName:Test-Computer-1$}]&addGroup=[Computer-Group,Computer-Group-2]&primaryGroup=Test-Group

Response:

[
    {
        "sAMAccountName": "Test-Computer-1$",
        "objectGUID": "{AF4A2A32-374C-4D74-A18A-DAE86AD45DBB}",
        "objectSID": "S-1-5-21-2058198098-2931619084-4035890149-8429",
        "userPrincipalName": "Test-Computer-1",
        "ouName": "OU=Computers,DC=test,DC=com",
        "statusMessage": "Successfully modified.",
        "status": "1"
    }
]

Technician-based create group limit

The total number of computers that technicians can add to a group in a day using the add computers to group API depends on the total number of licensed help desk technicians (HDTs) in ADManager Plus.

If an API is used to add five AD computers, and three of them are successfully found while two fail, it will be considered as three API calls. The maximum number of API calls an HDT can make is 50/day, irrespective of the tasks the HDT performs. If you have two HDT licenses, the total number of API calls that you can make is 100/day.

As the per day API call limit is not task-specific, you can perform any operation but the total number of API calls should not exceed 100. That is, an HDT can perform a variety of operations like user creation, OU creation, password reset, etc., but the number of API calls for all the tasks put together should not exceed 100.

Note:

The default admin account will not be considered a HDT.
Ensure that you URL encode all the special and reserved characters used in REST API requests. Since the client sending the request (browser, postman or TP tools) does not fall under the purview ADManager Plus, encoding the URL for special, reserved and unsafe characters is solely the users' responsibility.

Reserved characters include ; /? : @ = &
Unsafe characters include < > # % { } | \ ^ ~ [ ] ` "'

Add computers to groups API

ADManager Plus Trusted By