Criar usuário remoto

Creates a remote user to log on to a VM for a multiplayer server build.

Allowed entity token types: title

Error codes

This operation may return the following PlayFab errors:

Error	Code
APINotEnabledForGameClientAccess	1082
MultiplayerServerBadRequest	1382
MultiplayerServerConflict	1386
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerNotFound	1385
MultiplayerServerTooManyRequests	1380
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388
ProductDisabledForTitle	1609

POST

MultiplayerServer

CreateRemoteUser

Create Remote User

curl --request POST \
  --url https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs",
  "VmId": "VmID1",
  "Username": "AUsername",
  "ExpirationTime": "2014-04-07T09:04:28"
}
'

import requests

url = "https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser"

payload = {
    "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
    "Region": "SouthCentralUs",
    "VmId": "VmID1",
    "Username": "AUsername",
    "ExpirationTime": "2014-04-07T09:04:28"
}
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({
    BuildId: '21781fa8-096d-4d9c-b699-75433d579285',
    Region: 'SouthCentralUs',
    VmId: 'VmID1',
    Username: 'AUsername',
    ExpirationTime: '2014-04-07T09:04:28'
  })
};

fetch('https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser', 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/MultiplayerServer/CreateRemoteUser",
  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([
    'BuildId' => '21781fa8-096d-4d9c-b699-75433d579285',
    'Region' => 'SouthCentralUs',
    'VmId' => 'VmID1',
    'Username' => 'AUsername',
    'ExpirationTime' => '2014-04-07T09:04:28'
  ]),
  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/MultiplayerServer/CreateRemoteUser"

	payload := strings.NewReader("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\",\n  \"VmId\": \"VmID1\",\n  \"Username\": \"AUsername\",\n  \"ExpirationTime\": \"2014-04-07T09:04:28\"\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/MultiplayerServer/CreateRemoteUser")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\",\n  \"VmId\": \"VmID1\",\n  \"Username\": \"AUsername\",\n  \"ExpirationTime\": \"2014-04-07T09:04:28\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser")

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  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\",\n  \"VmId\": \"VmID1\",\n  \"Username\": \"AUsername\",\n  \"ExpirationTime\": \"2014-04-07T09:04:28\"\n}"

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

{
  "code": 123,
  "status": "<string>",
  "data": {
    "ExpirationTime": "<string>",
    "Password": "<string>",
    "Username": "<string>"
  }
}

{
  "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

Creates a remote user to log on to a VM for a multiplayer server build in a specific region. Returns user credential information necessary to log on.

BuildId

string

obrigatório

The guid string build ID of to create the remote user for.

Region

enum<string>

obrigatório

The region of virtual machine to create the remote user for.

Opções disponíveis:

AustraliaEast,

AustraliaSoutheast,

BrazilSouth,

CentralUs,

EastAsia,

EastUs,

EastUs2,

JapanEast,

JapanWest,

NorthCentralUs,

NorthEurope,

SouthCentralUs,

SoutheastAsia,

WestEurope,

WestUs,

SouthAfricaNorth,

WestCentralUs,

KoreaCentral,

FranceCentral,

WestUs2,

CentralIndia,

UaeNorth,

UkSouth,

SwedenCentral,

CanadaCentral,

MexicoCentral,

WestUs3,

CanadaEast,

UkWest,

FranceSouth,

SouthIndia,

SpainCentral,

GermanyWestCentral,

ItalyNorth,

IndonesiaCentral,

ChileCentral,

PolandCentral,

NewZealandNorth,

BrazilSoutheast,

NorwayEast,

SwitzerlandNorth,

MalaysiaWest,

IsraelCentral,

QatarCentral,

UaeCentral,

GermanyNorth,

AustriaEast,

BelgiumCentral,

DenmarkEast,

SwitzerlandWest,

SwedenSouth,

NorwayWest,

SouthAfricaWest,

MalaysiaSouth

Username

string

obrigatório

The username to create the remote user with.

VmId

string

obrigatório

The virtual machine ID the multiplayer server is located on.

CustomTags

object

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

ExpirationTime

string

The expiration time for the remote user created. Defaults to expiring in one day 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

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

Tópicos relacionados

Excluir usuário remoto Início rápido do SDK de Matchmaking PartyXblManager::CreateRemoteChatUser XBOX Manager: controle remoto Criar discos

⌘I

Create Remote User

curl --request POST \
  --url https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs",
  "VmId": "VmID1",
  "Username": "AUsername",
  "ExpirationTime": "2014-04-07T09:04:28"
}
'

import requests

url = "https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser"

payload = {
    "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
    "Region": "SouthCentralUs",
    "VmId": "VmID1",
    "Username": "AUsername",
    "ExpirationTime": "2014-04-07T09:04:28"
}
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({
    BuildId: '21781fa8-096d-4d9c-b699-75433d579285',
    Region: 'SouthCentralUs',
    VmId: 'VmID1',
    Username: 'AUsername',
    ExpirationTime: '2014-04-07T09:04:28'
  })
};

fetch('https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser', 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/MultiplayerServer/CreateRemoteUser",
  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([
    'BuildId' => '21781fa8-096d-4d9c-b699-75433d579285',
    'Region' => 'SouthCentralUs',
    'VmId' => 'VmID1',
    'Username' => 'AUsername',
    'ExpirationTime' => '2014-04-07T09:04:28'
  ]),
  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/MultiplayerServer/CreateRemoteUser"

	payload := strings.NewReader("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\",\n  \"VmId\": \"VmID1\",\n  \"Username\": \"AUsername\",\n  \"ExpirationTime\": \"2014-04-07T09:04:28\"\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/MultiplayerServer/CreateRemoteUser")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\",\n  \"VmId\": \"VmID1\",\n  \"Username\": \"AUsername\",\n  \"ExpirationTime\": \"2014-04-07T09:04:28\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/CreateRemoteUser")

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  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\",\n  \"VmId\": \"VmID1\",\n  \"Username\": \"AUsername\",\n  \"ExpirationTime\": \"2014-04-07T09:04:28\"\n}"

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

{
  "code": 123,
  "status": "<string>",
  "data": {
    "ExpirationTime": "<string>",
    "Password": "<string>",
    "Username": "<string>"
  }
}

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

PlayFab API

PlayFab REST API References

Criar usuário remoto

Error codes

Autorizações

Corpo

Resposta