Creating User Groups

Prerequisites

  • User groups feature enabled (enable_user_groups configuration flag)

  • Permission: data:user_group:create

API Endpoint

POST /groups

Request Body

{
  "name": "Data Engineers",
  "description": "Engineering team responsible for data pipelines"
}

Fields:

  • name (required): Group name, 1-255 characters, must be unique

  • description (optional): Group description

Response

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

Example:

curl -X POST "https://api.example.com/groups" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Data Engineers",
    "description": "Engineering team responsible for data pipelines"
  }'

Notes

  • The creator becomes the group owner

  • Only the creator can delete the group

  • Group names must be unique across the system

Last updated