User groups

Introduction

We usually interpret a user group as precisely what the name says: “a group of users”. For example, you may want to group users by their home country or any other characteristic.

User groups are used for notifications. Instead of listing all users, you can set one or multiple groups of users.

Manage user groups

You can manage user groups via ROQ Console (opens in a new tab) or createUserGroup() API. A user group has a name (e.g. “The Mavericks” or “The Gourmet Kitchen”). In addition, you can define a project-specific reference that enables you to fetch user groups using your identifier.

Add and remove users

You can add and remove users from a user group in ROQ Console (opens in a new tab) or use the addUsersToUserGroup() API. Group memberships are also shown for each user in the console.