Documentation

CreateRemoteUser

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

Request Details

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.

CreateRemoteUserRequest
Request Properties
BuildId (required) String

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

ExpirationTime DateTime

The expiration time for the remote user created. Defaults to expiring in one day if not specified.

Region (required) AzureRegion

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

Username (required) String

The username to create the remote user with.

VmId (required) String

The virtual machine ID the multiplayer server is located on.

POST https://{{TitleID}}.playfabapi.com/MultiplayerServer/CreateRemoteUser
    Content-Type: application/json
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs",
  "VmId": "VmID1",
  "Username": "AUsername",
  "ExpirationTime": "2014-04-07T09:04:28Z"
}
        

Response Details

CreateRemoteUserResponse
Result Properties
ExpirationTime DateTime

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.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

EntityToken

Possible Error Codes

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