playfab_ex v0.2.2 PlayfabEx.Client.Authentication

Link to this section Summary

Functions

Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See for more details

Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate

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

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

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

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

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

Signs the user in using their Google account credentials

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

Signs the user in using a Kongregate player account

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

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

Signs the user in using a Twitch access token

Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server

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

Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user

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

Link to this section Functions

Link to this function get_photon_authentication_token(params)
get_photon_authentication_token(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See for more details.

online docs

Link to this function get_title_public_key(params)
get_title_public_key(map()) :: {:ok, map()} | {:error, String.t()}

Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate.

online docs

Link to this function get_windows_hello_challenge(params)
get_windows_hello_challenge(map()) ::
  {:ok, map()} |
  {:error, String.t()}

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

online docs

Link to this function login_with_android_device_id(params)
login_with_android_device_id(map()) ::
  {:ok, map()} |
  {:error, String.t()}

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

online docs

Link to this function login_with_custom_id(params)
login_with_custom_id(map()) :: {:ok, map()} | {:error, String.t()}

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.

online docs

Link to this function login_with_email_address(params)
login_with_email_address(map()) :: {:ok, map()} | {:error, String.t()}

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

online docs

Link to this function login_with_facebook(params)
login_with_facebook(map()) :: {:ok, map()} | {:error, String.t()}

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

online docs

Link to this function login_with_game_center(params)
login_with_game_center(map()) :: {:ok, map()} | {:error, String.t()}

Signs the user in using their Google account credentials

online docs

Link to this function login_with_google_account(params)
login_with_google_account(map()) ::
  {:ok, map()} |
  {:error, String.t()}

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

online docs

Link to this function login_with_ios_device_id(params)
login_with_ios_device_id(map()) :: {:ok, map()} | {:error, String.t()}

Signs the user in using a Kongregate player account.

online docs

Link to this function login_with_kongregate(params)
login_with_kongregate(map()) :: {:ok, map()} | {:error, String.t()}

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.

online docs

Link to this function login_with_play_fab(params)
login_with_play_fab(map()) :: {:ok, map()} | {:error, String.t()}

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

online docs

Link to this function login_with_steam(params)
login_with_steam(map()) :: {:ok, map()} | {:error, String.t()}

Signs the user in using a Twitch access token.

online docs

Link to this function login_with_twitch(params)
login_with_twitch(map()) :: {:ok, map()} | {:error, String.t()}

Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server.

online docs

Link to this function login_with_windows_hello(params)
login_with_windows_hello(map()) :: {:ok, map()} | {:error, String.t()}

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.

online docs

Link to this function register_play_fab_user(params)
register_play_fab_user(map()) :: {:ok, map()} | {:error, String.t()}

Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user

online docs

Link to this function register_with_windows_hello(params)
register_with_windows_hello(map()) ::
  {:ok, map()} |
  {:error, String.t()}

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.

online docs

Link to this function set_player_secret(params)
set_player_secret(map()) :: {:ok, map()} | {:error, String.t()}

online docs