Retrieving User Group Information

Get All Groups

GET /groups/list?limit=50&offset=0&search=engineers

Query Parameters:

• limit (default: 50): Maximum number of results

• offset (default: 0): Pagination offset

• search (optional): Search by group name (case-insensitive)

Response:

{
  "groups": [
    {
      "identifier": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Data Engineers",
      "description": "Engineering team responsible for data pipelines"
    }
  ]
}

Get Specific Group

GET /groups?identifier={group_identifier}

Get Group Members

GET /groups/members?identifier={group_identifier}&limit=50&offset=0

Query Parameters:

• identifier (required): Group UUID

• limit (default: 50): Maximum number of results

• offset (default: 0): Pagination offset

Get Current User's Groups

GET /principal/user/groups

Returns all groups the authenticated user belongs to.

Constraints and Validation

1. Name Uniqueness: Group names must be unique across the system

2. Name Length: 1-255 characters

3. Description: Optional, no length limit

4. Creator Ownership: Only the creator can delete a group

5. Cascade Deletes: Deleting a group removes all memberships and role assignments