NEnetxms
User Groups

Get user group details

Changed on

Retrieve details of a specific user group by ID. Group IDs include the GROUP_FLAG bit (0x40000000). Requires MANAGE_USERS access right.

get/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, e.g. 1073741824 for Everyone)

Response

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

  • c2e2aa6afa48Revision changes
    • info

      api operation id getUserGroup was added

  • eaae46aefd15Revision 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