Documentation

ListMembership

Lists all groups and roles for an entity

Request Details

Lists the groups and roles that an entity is a part of, checking to see if group and role metadata and memberships should be visible to the caller. If the entity is not in any roles that are visible to the caller, the group is not returned in the results, even if the caller otherwise has permission to see that the entity is a member of that group.

ListMembershipRequest
Request Properties
Entity EntityKey

The entity to perform this action on.

POST https://{{TitleID}}.playfabapi.com/Group/ListMembership
    Content-Type: application/json
{}
        

Response Details

ListMembershipResponse
Result Properties
Groups List<GroupWithRoles>

The list of groups

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Groups": [
      {
        "GroupName": "Example Group",
        "Group": {
          "Id": "ABC1234ABC"
        },
        "ProfileVersion": 17,
        "Roles": [
          {
            "RoleName": "Example Role",
            "RoleId": "ABC123DEF"
          }
        ]
      }
    ]
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089