Groups
Overview
AccelByte Cloud's Groups service allows players to gather to chat and play together. This service allows players to create, join, and invite other players to groups. Group admins can also manage join requests and add members to or remove members from their group. The Groups service can be integrated with other services such as Lobby, Statistics, and Leaderboards, to extend its functionality. For example, you can create groups for players that have achieved a specific level or rank in your game.
Group Types
There are three types of groups that can be created:
- Open Groups are searchable and do not require any approval to join. A player can search for the group using the Group Name or Group Code, and then join the group without waiting for a group admin to approve their request.
- Public Groups are searchable but require permission to join. When a player tries to join, they must first wait for a group admin to approve their request. These groups often have membership requirements, such as only allowing players with an MMR of more than 100 to join the group.
- Private Groups can't be searched and require permission to join. Players can only join these groups if they've been invited by an admin.
Prerequisites
Make sure you've read about Roles Management to know the basics of creating a role.
Permissions
Permissions are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to manage groups in the Admin Portal. For a full list of permissions that impact groups management, see the Groups tab of the Permissions Reference.
| Usage | Resource | Action |
|---|---|---|
| List Group Configuration | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Read |
| Create New Configuration | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Create |
| Initiate Configuration | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Create |
| >Get Existing Configuration | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Read |
| Delete Group Configuration | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Delete |
| Update Existing Configuration | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Update |
| Update Existing Configuration Global Rule | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Update |
| Delete Existing Configuration Global Rule Based On Allowed Action | ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION | Update |
| Get List Of Groups | ADMIN:NAMESPACE:{namespace}:GROUP | Read |
| Get Single Group | ADMIN:NAMESPACE:{namespace}:GROUP | Read |
| Delete Existing Group | ADMIN:NAMESPACE:{namespace}:GROUP:{groupId} | Delete |
| Get a List Of Group Members | ADMIN:NAMESPACE:{namespace}:GROUP:MEMBER | Read |
| Get All List Of Member Roles | ADMIN:NAMESPACE:{namespace}:GROUP:ROLE | Read |
| Create New Member Role | ADMIN:NAMESPACE:{namespace}:GROUP:ROLE | Create |
| Get the Member Role | ADMIN:NAMESPACE:{namespace}:GROUP:ROLE | Read |
| Delete Member Role | ADMIN:NAMESPACE:{namespace}:GROUP:ROLE | Delete |
| Update Member Role | ADMIN:NAMESPACE:{namespace}:GROUP:ROLE | Update |
| Update Member Role Permission | ADMIN:NAMESPACE:{namespace}:GROUP:ROLE | Update |
Permissions work slightly differently depending on whether they are assigned to IAM Clients or Roles assigned to users. For more information, read the Authentication and Authorization documentation.