Sign in

v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB
User Groups

Update user group

Update an existing user group. Only the fields provided in the request body will be modified. Requires MANAGE_USERS access right.

put/v1/user-groups/{group-id}

Path parameters

group-idinteger required

Group ID (includes GROUP_FLAG bit)

Request body

namestring

New group name

descriptionstring

Group description

systemRightsinteger

System access rights bitmask

uiAccessRulesstring

UI access rules

attributesobject

Custom attributes (replaces all existing attributes)

membersinteger[]

List of member user IDs (replaces current members)

Response

User group updated 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