User Groups

Create user group

Changed on

Create a new user group. Requires MANAGE_USERS access right.

post/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

Request body

namestring required

Login name (must be a valid object name)

Response

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

    • info

      api operation id createUserGroup was added

    • 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