Documentation

IsMember

Checks to see if an entity is a member of a group or role within the group

Request Details

Checks to see if an entity is a member of a group or role within the group. A result indicating if the entity is a member of the group is returned, or a permission error if the caller does not have permission to read the group's member list.

IsMemberRequest
Request Properties
Entity (required) EntityKey

The entity to perform this action on.

Group (required) EntityKey

The identifier of the group

RoleId String

Optional: ID of the role to check membership of. Defaults to any role (that is, check to see if the entity is a member of the group in any capacity) if not specified.

POST https://{{TitleID}}.playfabapi.com/Group/IsMember
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "RoleId": "ABC1234DEF",
  "Entity": {
    "Id": "90901000",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
        

Response Details

IsMemberResponse
Result Properties
IsMember (required) Boolean

A value indicating whether or not the entity is a member.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "IsMember": true
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089