Agent Tunnels3

AI Chat7

AI Management3

AI Memory5

AI Operators14

AI Saved Prompts5

Alarm Categories5

Alarms10

Asset Management Schema5

Authentication2

Background Tasks1

Chat Bots7

Cloud Connectors1

Data Collection11

Data Export4

DCI Summary Tables7

Event Forwarders7

Event Processing Policy8

Event Templates5

Events1

Find2

Geo Areas5

Grafana8

Image Library6

Incidents10

Log Parsers2

Logs5

Mapping Tables5

Notification Channels9

Object Categories5

Object Tools10

Objects92

Persistent Storage4

Scheduled Tasks6

Script Library7

Server8

Server Actions5

Server Console3

SNMP MIB2

SNMP Trap Mappings5

SSH Keys5

TCP Proxy2

Traffic Observers1

Two-Factor Authentication9

User Groups5

Users13

Web Service Definitions5

User Groups

List user groups

Changed on Apr 16, 2026

Retrieve a list of all user groups defined in the system. Requires MANAGE_USERS access right.

get/v1/user-groups

Request

Base URL
http://127.0.0.1:8000
URL
http://127.0.0.1:8000/v1/user-groups
Auth
HTTP bearer

Response

User groups retrieved successfully

idinteger

Group ID (includes GROUP_FLAG bit 0x40000000)

guidstring uuid

Group GUID

namestring

Group name

descriptionstring

Group description

systemRightsinteger

System access rights bitmask

uiAccessRulesstring

UI access rules

attributesobject

Custom attributes

ldapDnstring nullable

LDAP distinguished name

ldapIdstring nullable

LDAP unique ID

createdinteger

Group creation time (Unix timestamp)

membersinteger[]

List of member user IDs

Changes

Apr 16, 2026c2e2aa6afa48 Revision changes
- info
  api operation id listUserGroups was added
Feb 20, 2026eaae46aefd15 Revision changes
- breaking
  the / response's property type changed from integer to object for status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history (3 revisions)

List user groups

Request

Response 200OK

Changes

Response