The remove member from group operation will remove a user, a group, a self service product or an application from a group.
Request
Request URI
| Method | Request URI |
|---|---|
| DELETE | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/users/{userNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/applications/{applicationNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/selfserviceproducts/{selfServiceProductGUID} |
| DELETE | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/membergroups/{memberGroupNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/users/{userNameOrGuid}/groups/{groupNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/applications/{applicationNameOrGuid}/groups/{groupNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/selfserviceproducts/{selfServiceProductGUID}/groups/{groupNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/groups/{memberGroupNameOrGuid}/groups/{groupNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/categories/{selfServiceCategoryGUID}/groups/{groupNameOrGuid} |
| DELETE | https://{company-name}.helloid.com/api/v1/groups/{groupNameOrGuid}/categories/{selfServiceCategoryGUID} |
Request parameters
| Parameter | Description |
|---|---|
| {groupNameOrGuid} | The name or the guid of the group to remove the member from |
| {userNameOrGuid} | The user name or guid to remove from the group |
| {applicationNameOrGuid} | The application name or guid to remove from the group |
| {selfServiceProductGUID} | The guid of self service product to remove from the group |
| {memberGroupNameOrGuid} | The name or the guid of group to remove from the group |
| {selfServiceCategoryGUID} | The guid of self service category to remove from the group |
Request headers
None.
Request body
None.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. Note however that when a non existing guid is supplied to the call a 200 is returned. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors 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. |
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 DELETE https://{company-name}.helloid.com/api/v1/users/{userNameOrGuid}/groups/{groupNameOrGuid}