Authentication - Get Photon Authentication Token

Service:

Client

API Version:

241025

Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.

POST https://titleId.playfabapi.com/Client/GetPhotonAuthenticationToken

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Request Body

Name	Required	Type	Description
PhotonApplicationId	True	string	The Photon applicationId for the game you wish to log into.

Responses

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

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GetPhotonAuthenticationTokenRequest
GetPhotonAuthenticationTokenResult

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

GetPhotonAuthenticationTokenRequest

Name	Type	Description
PhotonApplicationId	string	The Photon applicationId for the game you wish to log into.

GetPhotonAuthenticationTokenResult

Name	Type	Description
PhotonCustomAuthenticationToken	string	The Photon authentication token for this game-session.

Error Codes

Name	Code
PhotonApplicationNotAssociatedWithTitle	1141
PhotonApplicationNotFound	1140
PhotonNotEnabledForTitle	1139