Skip to main content
POST
Login With Server Custom Id

Authorizations

X-SecretKey
string
header
required

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

Body

application/json
ServerCustomId
string
required

The backend server identifier for this player.

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.

Example:
PlayerSecret
string

Player secret that is used to verify API request signatures.

Response

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
Last modified on October 1, 2026