É membro

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

Error codes

This operation may return the following PlayFab errors:

Error	Code
RoleDoesNotExist	1358

POST

Group

IsMember

Is Member

curl --request POST \
  --url https://{titleId}.playfabapi.com/Group/IsMember \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "RoleId": "ABC1234DEF",
  "Entity": {
    "Id": "90901000",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Group/IsMember"

payload = {
    "Group": { "Id": "ABC1234ABC" },
    "RoleId": "ABC1234DEF",
    "Entity": {
        "Id": "90901000",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Group: {Id: 'ABC1234ABC'},
    RoleId: 'ABC1234DEF',
    Entity: {
      Id: '90901000',
      Type: 'title_player_account',
      TypeString: 'title_player_account'
    }
  })
};

fetch('https://{titleId}.playfabapi.com/Group/IsMember', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Group/IsMember",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Group' => [
        'Id' => 'ABC1234ABC'
    ],
    'RoleId' => 'ABC1234DEF',
    'Entity' => [
        'Id' => '90901000',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Group/IsMember"

	payload := strings.NewReader("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"ABC1234DEF\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Group/IsMember")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"ABC1234DEF\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Group/IsMember")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"ABC1234DEF\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "IsMember": true
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizações

X-EntityToken

string

header

obrigatório

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Corpo

application/json

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.

Entity

object

obrigatório

The entity to perform this action on.

Show child attributes

Group

object

obrigatório

The identifier of the group

Show child attributes

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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.

Resposta

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Exemplo:

{ "IsMember": true }

Última modificação em 6 de outubro de 2026

⌘I

Is Member

curl --request POST \
  --url https://{titleId}.playfabapi.com/Group/IsMember \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "RoleId": "ABC1234DEF",
  "Entity": {
    "Id": "90901000",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Group/IsMember"

payload = {
    "Group": { "Id": "ABC1234ABC" },
    "RoleId": "ABC1234DEF",
    "Entity": {
        "Id": "90901000",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Group: {Id: 'ABC1234ABC'},
    RoleId: 'ABC1234DEF',
    Entity: {
      Id: '90901000',
      Type: 'title_player_account',
      TypeString: 'title_player_account'
    }
  })
};

fetch('https://{titleId}.playfabapi.com/Group/IsMember', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Group/IsMember",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Group' => [
        'Id' => 'ABC1234ABC'
    ],
    'RoleId' => 'ABC1234DEF',
    'Entity' => [
        'Id' => '90901000',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Group/IsMember"

	payload := strings.NewReader("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"ABC1234DEF\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Group/IsMember")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"ABC1234DEF\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Group/IsMember")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"ABC1234DEF\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "IsMember": true
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

É membro

Error codes

Autorizações

Corpo

Resposta