The remove group from role operation will remove groups from a role.
Request
Request URI
| Method | Request URI |
|---|---|
| DELETE | https://{company-name}.helloid.com/api/v1/roles/{roleNameOrGuid}/groups |
Request parameters
| Parameter | Description |
|---|---|
| {roleNameOrGuid} | The name or the guid of the role to remove the groups from |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Request body
{
"GroupGuids": ["3216f4b1-c290-4b6f-8ddb-921889331f56","02cab5e8-3355-4558-98bc-5504aedab679"]
}
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 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/roles/{roleNameOrGuid}/groups -H
Content-Type:application/json" -d
"{
'GroupGuids': ['0422b39f-dc8d-4186-ad80-ffb00a9ca3b1']
}"