Skip to content
ulamsulamsulams docs

User groups

Users → User groups organises accounts into groups. Groups can be nested, and a group can be given access to a course as a whole (on the course’s access tab; see Content creators). Groups belong to the auth package (/api/admin/user-groups).

Access given to a group reaches the members of its sub-groups too, down to 10 levels below it. A group that ends up as its own ancestor does not make the lookup loop.

Screen Route Permission needed to see it
Group list /users/groups user-group_list
New or edit group /users/groups/:group (new for a new group) user-group_read

Creating, updating and deleting groups and changing members are checked by the API with user-group_create, user-group_update, user-group_delete, user-group_member-add and user-group_member-remove.

The group list

Section titled “The group list”
The user group list with search and the Show tree button

The table shows ID, the full name (the group name with its parents, for example School / Class 1A), the name, Registerable and the parent group. Search by name or filter by parent. Show tree opens the whole hierarchy in a dialog.

Creating or editing a group

Section titled “Creating or editing a group”
  1. Click New on the list, or Edit on a row.
  2. Enter a Name and, optionally, a Parent group. Leave the parent empty for a top-level group.
  3. Turn on Registerable if people may join the group themselves when they register.
  4. Click Submit.
  5. On an existing group, use Add user to group to search for a user by name and add them. Delete next to a member removes them from the group.

Adding and removing members takes effect immediately and dispatches the UserAddedToGroup and UserRemovedFromGroup events, which have email templates (see Templates). You can also change a user’s groups from the user’s edit screen; see Users.

Registerable groups

Section titled “Registerable groups”

Groups marked Registerable are listed without authentication at GET /api/auth/registerable-groups. A registration form can offer them, and the registration request accepts a groups array: the new user is added only to the groups in that list that are registerable. Other groups are ignored.

Group import and export

Section titled “Group import and export”

The csv-users package has endpoints to export the members of a group and import a group (/api/admin/csv/groups, permissions csv-user_group_export and csv-user_group_import). The admin panel does not use them. When users are imported from a file, the group names in their groups column are created if they do not exist; see Users.