Authentication

Authentication APIs

Operations

Get Photon Authentication Token

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.

Get Title Public Key

Returns the title's base 64 encoded RSA CSP blob.

Login With Android Device ID

Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Login With Apple

Signs in the user with a Sign in with Apple identity token.

Login With Custom ID

Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Login With Email Address

Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser.

Login With Facebook

Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Login With Facebook Instant Games Id

Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Requires Facebook Instant Games to be configured.

Login With Game Center

Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.

Login With Google Account

Signs the user in using their Google account credentials

Login With IOS Device ID

Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Login With Kongregate

Signs the user in using a Kongregate player account.

Login With Nintendo Service Account

Signs in the user with a Nintendo service account token.

Login With Nintendo Switch Device Id

Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Login With OpenId Connect

Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.

Login With PlayFab

Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.

Login With PSN

Signs the user in using a PlayStation Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Login With Steam

Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Login With Twitch

Signs the user in using a Twitch access token.

Login With Xbox

Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Register PlayFab User

Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address.

Set Player Secret

Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.