User Group

User groups allow you to simplify the management of users' object rights and permissions.

You can put multiple users in a user group. These users would have permissions that are assigned to a group.

Rights and permissions granted by the user group are added to the users' existing rights and permissions. To allow a user to perform a certain action in the system, you can add the necessary permission either to users themselves or a user group they’re in.

User Group Model

Field Type Description

entityType

Integer

Entity Type. For a user group, entity type is 12.

eventFilter

Array<EventFilter>

An array of event filters configured for the user group. Users belonging to this group automatically inherit these event filters.

id

String

User group’s ID.

name

String

User group’s name.

objectPermissions

Object

Object access configuration for users in this group.

objectPermissions.include

Array<String>

An array of objects' IDs to which users of this group have access. See an article about permissions for details.

objectPermissions.exclude

Array<String>

An array of objects' IDs to which users of this group don’t have access. See an article about permissions for details.

permissions

Array<String>

An array of permissions available to users belonging to this group. See an article about permissions for details.

source

Object

User Group’s source.

source.sourceType

Integer

This parameters specifies a way to authenticate the user. Possible values are 0 (or null) for a standard authentication, 1 for authentication via LDAP server, 2 for Keycloak authentication.

source.data

String

Information about user group’s source.

For LDAP source, contains DN (Distinguished Name) of the LDAP group.