Delete Group
This API deletes an existing group identified by its unique ID. Once deleted, the group can no longer be used or managed within the system.
Endpoint Details
| URL | /v1/auth/groups/id |
| Method | DELETE |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Path
To delete a specific group, use the following request format:
/v1/auth/groups/8c9258f8-14c9-42c5-978b-f7a652c13444
Path Parameter
| Parameter | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the group to delete |
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 group was successfully deleted |
info
- A valid Bearer Token is required to access this endpoint.
- The
idpath parameter must reference an existing group. - Deleting a group is permanent and cannot be undone.