Skip to main content
Version: 5.7.0

Group

Groups are used to represent and manage a collection of brainCloud users. They are most commonly used to represent Teams in apps, and Clans in games.

Groups are designed as follows:

  • Groups consist of a collection of members (users)
  • Groups have a name, a type, an id, and custom data
  • Members are each assigned a role-based permission level: "OWNER", "ADMIN", or "MEMBER"
    • Groups have one (and only one) "OWNER". The OWNER of a group can add/remove members, and delete the group
    • Groups can have multiple "ADMIN"s. ADMINs are like OWNERs, except that they cannot delete the group.
    • Any "MEMBER" can edit group data
  • MEMBERs of a group can have custom attributes associated with them (can be used for custom application roles, etc.)
  • Users can be members of more than one group
  • Users can be the owner of more than one group
  • Groups can also have associated Entities (i.e. GroupEntity)

Groups are made up of the following attributes:

AttributeDescription
groupIdID of the group
ownerIdProfileId of the end-user who owns the group
nameName of the group
typeType of group. This is a developer-defined type, that establishes some rules for the group.
membersthe members of the group
pendingMembersmembers who have been invited to the group, but have not yet accepted
datajson-data associated with the group
aclcontrols visibility of data and members list for non-members

To create a group you must first configure a Group Type on the Group Types page of the brainCloud portal.

API Summary​

Group Management​

Group members​

Locating Groups​

Group entities​

System calls​

Last updated on by Jason Liang