Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/groups/{groupId}/removeUser/{userId}
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Removes a user from the specified group. To obtain the userId value in the endpoint, run the Get Users - API call first. The user's id value in the response is the userId value that you use in this endpoint. To obtain the groupId value in the endpoint, run the Get Groups - API call first. The group's id value in the response is the groupId value that you use in this endpoint. |
Required Permission | Manage Groups |
Version Introduced | 2.7. |
6 |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Sample Call:
| Code Block | theme | Eclipse
|---|
curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST https://localhost:8443/threadfix/rest/latest/groups/1/removeUser/3 |
Sample Output:
| Code Block | theme | Eclipse
|---|
{
"message": "",
"success": true,
"responseCode": -1,
"object": "Successfully removed user from group."
} |
| Page Tree | ||
|---|---|---|
|