Entitlement required: manageUserGroups (Manage users and groups), or manageAllUserGroups (Synchronize users and groups), or manageUserStandardGroups (Manage users and standard groups), or manageGroups (Manage all groups but not their members), or manageStandardGroups (Manage standard groups but not their members), or manageGroupMembers (Manage all group and their members), or manageStandardGroupMembers (Manage standard groups and their members).
Note: You only need one entitlement, but you can have more than one.
On Success, the return response contains the members and details of the group. The HTTP PUT method is used to replace the resource's attributes. For example, clients that previously retrieved the entire resource and revised it, can replace the resource by using an HTTP PUT.
By default, an email is sent to each regular user member added and removed from the group. Federated user members do not get an email notification. The email templates for branding are at "notifications/user_management/group/{locale}/user_added_to_group_email.xml" and "notifications/user_management/group/{locale}/user_removed_from_group_email.xml". Pass in the themeId query parameter to brand the email templates for notifications. To turn off email notifications, send the notifications option "urn:ietf:params:scim:schemas:extension:ibm:2.0:Notification": {"notifyType":"NONE"} in the payload.
Limitations for tenants that do not support large groups:
- A group with more than 10,000 members cannot be modified. Use PATCH instead.
Limitations for tenants that support large groups:
| - A group with over 2,500 group members cannot be modified. Use PATCH instead. |
| - The "size" of the changes to a group cannot exceed 2,500 member modifications. |
| - A maximum of 256 first-level, nested group members are allowed. |
To check whether the tenant supports large groups, run the GET /v2.0/SCIM/capabilities API.