playfab_ex v0.2.0 PlayfabEx.Admin.Default.AccountManagement

Link to this section Summary

Functions

Bans users by PlayFab ID with optional IP address, or MAC address for the provided game

Removes a user’s player account from a title and deletes all associated data

Permanently deletes a title and all associated configuration

Gets a player’s ID from an auth token

Retrieves the player’s profile

Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier

Gets all bans for a user

Reset a player’s password for a given title

Revoke all active bans for a user

Revoke all active bans specified with BanId

Forces an email to be sent to the registered email address for the specified account, with a link allowing the user to change the password

Updates information of a list of existing bans specified with Ban Ids

Updates the title specific display name for a user

Link to this section Functions

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

Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.

@link https://api.playfab.com/documentation/admin/method/BanUsers

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

Removes a user’s player account from a title and deletes all associated data

@link https://api.playfab.com/documentation/admin/method/DeletePlayer

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

Permanently deletes a title and all associated configuration

@link https://api.playfab.com/documentation/admin/method/DeleteTitle

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

Gets a player’s ID from an auth token.

@link https://api.playfab.com/documentation/admin/method/GetPlayerIdFromAuthToken

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

Retrieves the player’s profile

@link https://api.playfab.com/documentation/admin/method/GetPlayerProfile

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

Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier

@link https://api.playfab.com/documentation/admin/method/GetUserAccountInfo

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

Gets all bans for a user.

@link https://api.playfab.com/documentation/admin/method/GetUserBans

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

Reset a player’s password for a given title.

@link https://api.playfab.com/documentation/admin/method/ResetPassword

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

Revoke all active bans for a user.

@link https://api.playfab.com/documentation/admin/method/RevokeAllBansForUser

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

Revoke all active bans specified with BanId.

@link https://api.playfab.com/documentation/admin/method/RevokeBans

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

Forces an email to be sent to the registered email address for the specified account, with a link allowing the user to change the password

@link https://api.playfab.com/documentation/admin/method/SendAccountRecoveryEmail

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

Updates information of a list of existing bans specified with Ban Ids.

@link https://api.playfab.com/documentation/admin/method/UpdateBans

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

Updates the title specific display name for a user

@link https://api.playfab.com/documentation/admin/method/UpdateUserTitleDisplayName