Pular para o conteúdo principal
POST
Login With Xbox Id

Autorizações

X-SecretKey
string
header
obrigatório

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Corpo

application/json

If this is the first time a user has signed in with the Xbox ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Xbox Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Xbox Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.

If this is the first time a user has signed in with the Xbox ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Xbox Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Xbox Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.

Sandbox
string
obrigatório

The id of Xbox Live sandbox.

XboxId
string
obrigatório

Unique Xbox identifier for a user.

CreateAccount
boolean

Automatically create a PlayFab account if one is not currently linked to this ID.

CustomTags
object

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

InfoRequestParameters
object

Flags for which pieces of info to return for the user.

Exemplo:

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
Última modificação em 6 de outubro de 2026