Deleting a User From Groups
AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: POST /user/{user_id}/groups/remove
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can delete users belonging to the departments they manage and their sub-departments.
Request Headers
Parameter | Description |
---|---|
Authorization (required) | Access token. You can obtain a token by making a request. |
Parameter | Description |
user_id (required) | The ID of a user you want to delete from groups. |
groupIds (required) | List of group IDs from which the user will be deleted. |
Possible Response Codes
Code | Text | Description |
---|---|---|
204 | OK | A user is deleted. |
400 | Bad Request | A request error. |
401 | Unauthorized | Authorization error. |
403 | Permission Denied | The user doesn't have enough permissions to delete another users. |
Sample Request XML
POST /user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
<?xml version="1.0" encoding="UTF-8"?>
<request>
<groupIds>
<id>c400156e-b9a6-11ec-b941-0242c0a8a039</id>
<id>9eebd6c0-d524-11ec-be4f-0242ac150039</id>
</groupIds>
</request>
CODE
Sample Request JSON
POST /user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
{
"groupIds": [
"c400156e-b9a6-11ec-b941-0242c0a8a039",
"9eebd6c0-d524-11ec-be4f-0242ac150039"
]
}
CODE
Sample Request curl - JSON
curl -X 'POST' \
'https://api-learn.ispring.lan/user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove' \
-H 'accept: */*' \
-H 'Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE' \
-H 'Content-Type: application/json' \
-d '{
"groupIds": [
"c400156e-b9a6-11ec-b941-0242c0a8a039",
"9eebd6c0-d524-11ec-be4f-0242ac150039"
]
}'
CODE
Sample Request curl - XML
curl -X 'POST' \
'https://api-learn.ispring.lan/user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove' \
-H 'accept: */*' \
-H 'Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE' \
-H 'Content-Type: application/xml' \
-d '<?xml version="1.0" encoding="UTF-8"?>
<request>
<groupIds>
<id>c400156e-b9a6-11ec-b941-0242c0a8a039</id>
<id>9eebd6c0-d524-11ec-be4f-0242ac150039</id>
</groupIds>
</request>'
CODE
Sample Response
https/1.1 204 OK
XML