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.

Note

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
id	String	User group's ID.
name	String	User group's name.
permissions	Array<String>	An array of permissions available to users belonging to this group. See an article about permissions for details.
eventFilter	Array<EventFilter>	An array of event filters configured for the user group. Users belonging to this group automatically inherit these event filters.
objectPermissions.include	Array<String>	An array of objects' IDs to which users of this group have the include permission. See an article about permissions for details.
objectPermissions.exclude	Array<String>	An array of objects' IDs to which users of this group have the exclude permission. See an article about permissions for details.