NEnetxms
User Groups

Update user group

Changed on

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}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/user-groups/{group-id}
  • Auth
    HTTP bearer

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, except those whose name starts with a dot - those are owned by client applications (UI state, user preferences) and are kept unless the request lists them explicitly. Null as a value removes the attribute.

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

Changes