Remove User from Group

This API removes a user from a specific group, identified by the group ID. The membership to remove is referenced by its group permission ID.

Endpoint Details

URL	/v1/auth/groups/id/members/remove
Method	POST
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Path

To remove a user from a specific group, use the following request format:

/v1/auth/groups/81ad4d05-d11a-4809-b1f2-cc000c086730/members/remove

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the group

---

Request Body

Use the following format to make a request:

JSON Request

{
  "id": "fb34c445-d702-498d-8020-42cd89c07d64",
  "user_id": "d7cdf0a4-ffbf-47be-987d-5b3c3ce9cf73"
}

---

Body Parameters

Parameter	Type	Description
id	UUID	Unique identifier of the group permission (obtained from the group_permission id)
user_id	UUID	Unique identifier of the user to remove from the group

---

Response

Here is an example response after the request has been successfully processed:

Response

{
    "success": true
}

---

Field Descriptions

Field	Type	Description
success	Boolean	Indicates whether the user was successfully removed from the group

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing group.
• The id in the request body is the group permission ID obtained from the group members list (group_permission id).
• The user_id in the request body must reference a user who is currently a member of the group.