update_group_members

Add users to a group, or remove them from it. Use list_group_members to see who is in it now.

This takes additions and removals rather than a complete list of who should be in the group. Nobody is added or removed here unless you name them. That is deliberately the other way round from the update_users tool, which takes a user’s whole list of groups. This is because a person belongs to only a few groups, but a group can have thousands of members.

All permissions in the system are assigned to groups; users receive permissions by virtue of the groups they are members of. Use get_form_permissions_by_group to see which permissions a group provides.

Some memberships are required and cannot be removed. This tool reports each such user individually, while completing the operation for the others.

Some groups are associated with the entries in forms (form-based entry groups). Such groups can have members like any other group. There are also form-based template groups, associated with a form itself. These cannot have members, because they simply represent the pattern that the entry groups follow.