Skip to main content

The Group

A group is a general-purpose grouping of users. It's the base type that several more specific facades build on — most notably the Team, which is a group with groupType = team. Reach for a group directly when you need a grouping that isn't a team (a department, a workgroup, a community).

Group vs Team

A Team is a specialization of a group. If you're organizing collaborators with roles around work, use teams; groups are the more general substrate underneath. They share the same members model.

How you address it​

/entitymanagement/v1/groups                          # list, create
/entitymanagement/v1/groups/{group}                  # retrieve, update, delete
/entitymanagement/v1/groups/{group}/members          # list / add members
/entitymanagement/v1/groups/{group}/members/{userId} # update / remove a member

All group endpoints are scoped.

Key fields​

FieldNotes
nameRequired; the group's name
groupTypedepartment, team, workgroup, community, custom — team is the Team facade
slugOptional identifier
description, metadataFreeform
isActiveWhether the group is active

Members and permissions​

  • Members — GET/POST /groups/{group}/members; update or remove a member with PUT/DELETE /groups/{group}/members/{userId}.
  • Per-member permissions — grant or revoke fine-grained permissions on a member under /groups/{group}/members/{userId}/permissions.

How those permissions resolve into what a user can actually do is covered in Permissions.

Relationships​

  • Specialized by the Team (groupType = team).
  • Contains member users.
  • Belongs to a tenant.
  • Carries the shared sub-resources under /entitymanagement/v1/group/{id}/….

See also​