The create AD group action operation will create an Active Directory group with the specified name.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/selfservice/products/{productGUID}/adcreategroupaction |
| POST | https://{company-name}.helloid.com/api/v1/selfservice/products/{productCode}/adcreategroupaction |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {productGUID} | The GUID for the self service product |
| {productCode} | The code for the self service product |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
{
"executeOnState": 1,
"variables": [
{
"name": "domain",
"value": "{{company.defaultAdDomain}}",
"typeConstraint": "string",
"secure": false
},
{
"name": "ouDistinguishedName",
"value": "OU=Users,DC=Company,DC=com",
"typeConstraint": "string",
"secure": false
},
{
"name": "groupName",
"value": "ExampleAdGroup",
"typeConstraint": "string",
"secure": false
},
{
"name": "groupDescription",
"value": "",
"typeConstraint": "string",
"secure": false
},
{
"name": "groupScope",
"value": 2,
"typeConstraint": "string",
"secure": false
},
{
"name": "isSecurityGroup",
"value": "true",
"typeConstraint": "boolean",
"secure": false
}
]
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| executeOnState | Indicates in which state the AD Group Member action will trigger. Possible values: 1. RequestCreated (default) 2. RequestCreateCompleted 3. RequestApproved 4. RequestApproveCompleted 5. RequestDenied 6. RequestDenyCompleted 7. RequestDeleted 8. RequestDeleteCompleted 9. RequestRevoked 10. RequestRevokeCompleted 11. RequestReturned 12. RequestReturnCompleted |
Optional | - |
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is created. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. The content type was incorrect or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
| 409(CONFLICT) | Indicates that the operation was not successful. If there were validation errors, the response will include an error result. |
Please also see error result.
Please also see common HTTP status codes.
Sample response body
{
"actionGUID": "5b038a81-89f1-4a79-b059-e2ae49e636a2",
"name": "Create an AD group",
"options": 1,
"objectGUID": "87ed7ecc-0ee7-4d9c-a718-341d2f6861fe",
"executeOnState": 1,
"automationStoreTaskId": "81cc4d59-018d-47a2-8cfa-81a2a64491fc",
"automationStoreTaskVersion": "1.0.0",
"executionType": "native",
"executionEntry": "ad-create-group",
"executionEnvironment": "helloid-agent",
"executionMinimumVersion": "1.1.0",
"variables": [
{
"id": "33a0bb81-d363-48b5-8b5f-504a8d29db84",
"name": "domain",
"value": "{{company.defaultAdDomain}}",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "2e5f7bc2-02b6-4364-a400-0d77485d4636",
"name": "groupDescription",
"value": "",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "619f7f34-0955-4164-9750-f1a07717a83c",
"name": "groupName",
"value": "ExampleAdGroup",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "ba10d645-9819-4a71-9e33-9ce0919d34f3",
"name": "groupScope",
"value": "2",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "db756419-98a2-43e2-943a-31675dcabe79",
"name": "isSecurityGroup",
"value": "true",
"typeConstraint": "boolean",
"secure": false,
"isScriptVariable": false
},
{
"id": "83b1d6a5-877d-4941-ac6b-2fb4b0a04d3d",
"name": "ouDistinguishedName",
"value": "OU=Users,DC=Company,DC=com",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
}
]
}
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X POST https://{company-name}.helloid.com/api/v1/selfservice/products/{productGUID}/adcreategroupaction -H "Content-Type:application/json" -d
'{
[request body here]
}'