메인 콘텐츠로 건너뛰기
POST
Create Remote User

인증

X-EntityToken
string
header
필수

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

본문

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.

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
필수

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

Region
enum<string>
필수

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

사용 가능한 옵션:
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
필수

The username to create the remote user with.

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

응답

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
마지막 수정일 2026년 10월 6일