The link member to group operation will add a user, an application, a group or an application to a group.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/users |
| POST | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/applications |
| POST | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/selfserviceproducts |
| POST | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/membergroups |
| POST | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/categories |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {groupNameOrGuid} | The name or Guid of the group to link a member to |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
{
"userGUID": "EF24276A-CF39-44D7-B8E5-1012C0DB5178"
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {userGUID} | Guid of the user to add to the group. Use with URI: https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/users |
Required | - |
| {applicationGUID} | Guid of the application to add to the group. Use with URI: https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/applications |
Required | - |
| {selfServiceProductGUID} | Guid of the self service product to add to the group. Use with URI: https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/selfserviceproducts |
Required | - |
| {groupGUID} | Guid of the group to add to the group. Use with URI: https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/membergroups |
Required | - |
| {selfServiceCategoryGUID} | Guid of the self service category to add to the group. Use with URI: https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/categories |
Required | - |
Please note that although both parameters are marked as required, they are mutually exclusive. This means that only one member can be added to the group in a single request.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. Note that if the group or the item to link couldn't be found the API will also return a 200. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed.If there were validation errors, the response will include a error result. |
| 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. |
Please not that if the parent or the member could not be found in the database the call will still return the response code 200, but no changes will have been made.
Please also see error result.
Please also see common HTTP status codes.
Sample response body
None.
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/groups/{groupNameOrGuid}/users -H "Content-Type:application/json" -d
"{
'UserGuid': 'EF24276A-CF39-44D7-B8E5-1012C0DB5178'
}"