Direct Inward Dialing: +1 408 916 9393
Free EditionUse this API to create a group in Active Directory (AD) from your application.
Request URL (JSON) format: http://<hostname>:<port>/RestAPI/CreateGroup
Request parameters:
Groups can be created using the POST method. Following are the request parameters that can be used in the request:
| Parameter name | Mandatory | Description |
| domainName | Yes | Name of the domain where the group has to be created. |
| 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. |
| inputFormat | Yes | Details of the group that has to be created in AD. This attribute should be JSONArray string and must be specified in this format: [<JSONObject>,<JSONObject>,<JSONObject>]; JSONObject - key/value pair of LDAP attributes and their corresponding values. |
| PRODUCT_NAME | Yes | Product name/module name from which the request is being sent; will be needed for auditing. |
Response:
The response will be a JSON array string with a list of JSONObjects. Each JSONObject in the list represents an object sent in the inputFormat attribute in the request. Each object will contain the following properties about the status:
| Parameter name | Description |
| status | Status of the operation. |
| statusMessage | Contains the message about the issues or errors that occur while performing the specified action. |
| OU Name | Name of the OU where the group is created. |
| Name | Name of the object created. |
Sample Input / Output
Request:
http://Byron:8080/RestAPI/CreateGroup?domainName=division-dc1.local&AuthToken=d762fe90-0c13-45cf-81fb-3b60e05bfef2&inputFormat=[{"name":"Account Operators", "templateName":"GroupTemplate2", "sAMAccountName":"Account Operators", "groupType":"Security", "groupScope":"Global", "member":"CN=AndyJones,CN=Users,DC=division-dc1,DC=local;CN=AccountsDesktop,CN=Users,DC=division-dc1,DC=local;CN=JohnSmith,OU=USA,OU=Accounts,DC=division-dc1,DC=local", "memberOf":"CN=FinanceDepartment,CN=Users,DC=division-dc1,DC=local", "OUName":"OU=Accounts,DC=division-dc1,DC=local"}]&PRODUCT_NAME=MODULE
Response:
[{"OU Name":"OU=Accounts,DC=division-dc1,DC=local","statusMessage":"Successfully created the group.","Name":"Account Operators","status":"1"}]
Technician-based create group limit
The total number of groups that technicians can create in a day using the create group API depends on the total number of licensed help desk technicians (HDTs) in ADManager Plus.
If an API is used to create five AD groups, and three of them are successfully created 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 HDTcan 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:
Reserved characters include ; /? : @ = &
Unsafe characters include < > # % { } | \ ^ ~ [ ] ` "'
