Multiplayer Server - Create Remote User

  • Reference
Service:
Multiplayer
API Version:
241025

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

POST https://titleId.playfabapi.com/MultiplayerServer/CreateRemoteUser

Request Header

Name Required Type Description
X-EntityToken True

string

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

Request Body

Name Required Type Description
BuildId True

string

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

AzureRegion

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

string

The username to create the remote user with.
VmId True

string

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.

Responses

Name Type Description
200 OK

CreateRemoteUserResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
AzureRegion
CreateRemoteUserRequest

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.
CreateRemoteUserResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

AzureRegion

Name Type Description
AustraliaEast

string

AustraliaSoutheast

string

BrazilSouth

string

CentralIndia

string

CentralUs

string

EastAsia

string

EastUs

string

EastUs2

string

FranceCentral

string

JapanEast

string

JapanWest

string

KoreaCentral

string

NorthCentralUs

string

NorthEurope

string

SouthAfricaNorth

string

SouthCentralUs

string

SoutheastAsia

string

SwedenCentral

string

UaeNorth

string

UkSouth

string

WestCentralUs

string

WestEurope

string

WestUs

string

WestUs2

string

CreateRemoteUserRequest

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.

Name Type Description
BuildId

string

The guid string build ID of to create the remote user for.
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.
Region

AzureRegion

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

string

The username to create the remote user with.
VmId

string

The virtual machine ID the multiplayer server is located on.

CreateRemoteUserResponse

Name Type Description
ExpirationTime

string

The expiration time for the remote user created.
Password

string

The generated password for the remote user that was created.
Username

string

The username for the remote user that was created.

Error Codes

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