User Groups API
User Groups API is used for synchronizing groups and their members. Changing group membership can change study tasks because content is often assigned to groups.
Supported tasks
Section titled “Supported tasks”| Task | Note |
|---|---|
| List groups | Returns groups in a company space. |
| Update group | Can change fields such as external_id, name, or self_assignable. |
| Add users | Users can be identified by internal IDs, personal_id, or e-mails. |
| Remove users | Supports the same identifier types as adding users. |
User identifiers
Section titled “User identifiers”Membership endpoints support:
primary_ids,personal_ids,emails.
If a user is not found among active users in the company space, the operation should fail. The integration should therefore have a clear process for missing or archived users.
Recommended synchronization model
Section titled “Recommended synchronization model”For periodic synchronization, it is better to send changes in batches and verify the result by listing the group after each batch. Bulk operations can have domain impact on content assignments and reporting.