Authentication - Authenticate Game Server With Custom Id

Service:

Authentication

API Version:

241122

Create a game_server entity token and return a new or existing game_server entity.

POST https://titleId.playfabapi.com/GameServerIdentity/AuthenticateGameServerWithCustomId

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
CustomId	True	string	The customId used to create and retrieve game_server entity tokens. This is unique at the title level. CustomId must be between 32 and 100 characters.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	AuthenticateCustomIdResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

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

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
AuthenticateCustomIdRequest	Create or return a game_server entity token. Caller must be a title entity.
AuthenticateCustomIdResult
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
EntityTokenResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

AuthenticateCustomIdRequest

Create or return a game_server entity token. Caller must be a title entity.

Name	Type	Description
CustomId	string	The customId used to create and retrieve game_server entity tokens. This is unique at the title level. CustomId must be between 32 and 100 characters.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

AuthenticateCustomIdResult

Name	Type	Description
EntityToken	EntityTokenResponse	The token generated used to set X-EntityToken for game_server calls.
NewlyCreated	boolean	True if the account was newly created on this authentication.

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

EntityTokenResponse

Name	Type	Description
Entity	EntityKey	The entity id and type.
EntityToken	string	The token used to set X-EntityToken for all entity based API calls.
TokenExpiration	string	The time the token will expire, if it is an expiring token, in UTC.