Documentation

DeleteRemoteUser

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

Request Details

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

DeleteRemoteUserRequest
Request Properties
BuildId (required) String

The guid string build ID of the multiplayer server where the remote user is to delete.

Region (required) AzureRegion

The region of the multiplayer server where the remote user is to delete.

Username (required) String

The username of the remote user to delete.

VmId (required) String

The virtual machine ID the multiplayer server is located on.

POST https://{{TitleID}}.playfabapi.com/MultiplayerServer/DeleteRemoteUser
    Content-Type: application/json
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs",
  "VmId": "VmID1",
  "Username": "AUsername"
}
        

Response Details

EmptyResponse
Result Properties

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