Group

API Summary

Group

• SysAddGroupMember - add a user as a member to the group, bypassing ownership/ACL checks. Optional parameters: role OR attributes.
• SysChangeGroupType - changes the group type
• SysCreateGroup - create a group
• SysCreateGroupEntity - create an entity in the group with no owner
• SysDeleteGroup - delete a group
• SysDeleteGroupEntity - delete an entity in the group
• SysGetRandomGroupsMatching - Gets a list of up to maxReturn randomly selected groups from the server based on the where condition, bypassing ownership/ACL checks
• SysIncrementGroupData - partial increment of group data field items. Partial set of items incremented as specified
• SysIncrementGroupEntityData - partial increment of group entity data field items. Partial set of items incremented as specified
• SysIsGroupMember - Verifies if user is a group member and returns information about group member, bypassing ownership/ACL checks
• SysListGroupsPage - retrieve a page of group summary information based on the specified context
• SysListGroupsPageByOffset - retrieve a page of group summary information based on the encoded context and specified page offset
• SysReadGroup - retrieve information about the group
• SysReadGroupData - retrieve a group's data object
• SysReadGroupEntitiesPage - retrieve a page of group entity information based on the specified context
• SysReadGroupEntitiesPageByOffset - retrieve a page of group entity information based on the encoded context and specified page offset
• SysReadGroupEntity - read an entity in the group
• SysReadGroupMembers - read all members in the group
• SysRemoveGroupMember - Remove a member from the group, bypassing group ownership/ACL checks.
• SysSetGroupOpen - Set whether a group is open (true) or closed (false)
• SysUpdateGroupAcl - update a group's access conditions
• SysUpdateGroupData - update a group's data
• SysUpdateGroupEntityAcl - Update the acl settings for a group entity, bypassing ownership/ACL checks.
• SysUpdateGroupEntityData - update the data for a group entity
• SysUpdateGroupMember - update a member of the group
• SysUpdateGroupName - update a group's name
• SysUpdateGroupSummaryData - update a group's summary data

tip

All the client APIs that the names beigin with "Sys" are also available to S2S. For the usages of the S2S Group APIs (if they are not listed at this section), refer to brainCloud client Group APIs.

📄️ SysChangeGroupType

Change the groupType of a given group.