The link group to member operation will add a user, a group, a self service product or an application to a group.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/users/{userNameOrGuid}/groups |
| POST | https://{company-name}.helloid.com/api/v1/applications/{applicationNameOrGuid}/groups |
| POST | https://{company-name}.helloid.com/api/v1/selfserviceproducts/{selfServiceProductGUID}/groups |
| POST | https://{company-name}.helloid.com/api/v1/categories/{selfServiceCategoryGuid}/groups |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {userNameOrGuid} | The name or Guid of the user to add to a group |
| {applicationNameOrGuid} | The name or Guid of the application to add to a group |
| {selfServiceProductGUID} | The Guid of the self service product to add to a group |
| {selfServiceCategoryGuid} | The Guid of the self service category to add to a group |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
{
"groupGUID": "EF24276A-CF39-44D7-B8E5-1012C0DB5178"
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {groupGUID} | Guid of the group to add the member to | Required | - |
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. 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/users/{userNameOrGuid}/groups-H "Content-Type:application/json" -d
"{
'groupGuid': 'EF24276A-CF39-44D7-B8E5-1012C0DB5178'
}"