User Groups API
User groups allow you to organize users into logical groups for easier management of ownership and permissions across Kordon resources.
POST /settings/user-groups/
Section titled “POST /settings/user-groups/”Create a new user group.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the user group. |
description | string | No | Description of the user group. |
color | string | No | Hex color code for the group badge (e.g., #5CDBD3). |
curl --location 'https://YOUR_KORDON_DOMAIN/api/v1/settings/user-groups/' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer YOUR-TOKEN' \--data '{ "user_group": { "name": "Security Team", "description": "Members of the information security team", "color": "#5CDBD3" }}'Example response:
Status 200
{ "data": { "id": "c1d2e3f4-a5b6-7890-cdef-123456789abc", "name": "Security Team", "description": "Members of the information security team", "color": "#5CDBD3", "active": true, "kind": "regular", "member_count": 0, "members": [], "permissions": { "update": true, "destroy": false, "connect": true, "changelog": true, "can_edit": true, "can_delete": false, "can_add_members": true, "can_remove_members": true } }}GET /settings/user-groups/
Section titled “GET /settings/user-groups/”List all user groups. Add ?include_members=true to include the full member list on each group.
curl --location 'https://YOUR_KORDON_DOMAIN/api/v1/settings/user-groups/?include_members=true' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer YOUR-TOKEN'Example response:
Status 200
{ "data": [ { "id": "c1d2e3f4-a5b6-7890-cdef-123456789abc", "name": "Security Team", "description": "Members of the information security team", "color": "#5CDBD3", "active": true, "kind": "regular", "member_count": 1, "members": [ { "id": "98dcb717-al70-4c89-8246-0bb026wc215b", "name": "Anna Smith", "active": true, "role": "admin", "picture": null } ], "permissions": { "update": true, "destroy": false, "connect": true, "changelog": true, "can_edit": true, "can_delete": false, "can_add_members": true, "can_remove_members": true } }, { "id": "d2e3f4a5-b6c7-8901-efab-234567890def", "name": "Compliance Team", "description": "Responsible for regulatory compliance", "color": "#FF7A45", "active": true, "kind": "regular", "member_count": 0, "members": [], "permissions": { "update": true, "destroy": true, "connect": true, "changelog": true, "can_edit": true, "can_delete": true, "can_add_members": true, "can_remove_members": true } } ], "meta": { "page": 1, "per_page": 25, "total_count": 2 }}POST /settings/user-groups/:id/memberships
Section titled “POST /settings/user-groups/:id/memberships”Add a user to a user group.
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string (UUID) | Yes | The ID of the user to add to the group. |
curl --location 'https://YOUR_KORDON_DOMAIN/api/v1/settings/user-groups/GROUP_ID/memberships' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer YOUR-TOKEN' \--data '{ "user_id": "44a2a59e-2ac4-47ea-a5fb-942107e690ef"}'Example response:
Status 200
{ "data": { "id": "76c0ac1d-04da-4485-b858-0518fec1d242", "active": true, "created_at": "2026-04-15T10:51:49+00:00", "updated_at": "2026-04-15T10:51:49+00:00" }, "meta": { "total_count": 2, "page": 1, "per_page": 10 }}