| PFAccountManagementAddOrUpdateContactEmailRequest | PFAccountManagementAddOrUpdateContactEmailRequest data model. This API adds a contact email to the player’s profile. If the player’s profile already contains a contact email, it will update the contact email to the email address specified. |
| PFAccountManagementAddUsernamePasswordRequest | PFAccountManagementAddUsernamePasswordRequest data model. |
| PFAccountManagementAddUsernamePasswordResult | PFAccountManagementAddUsernamePasswordResult data model. Each account must have a unique username and email address in the PlayFab service. Once created, the account may be associated with additional accounts (Steam, Facebook, Game Center, etc.), allowing for added social network lists and achievements systems. This can also be used to provide a recovery method if the user loses their original means of access. |
| PFAccountManagementBanInfo | PFAccountManagementBanInfo data model. Contains information for a ban. |
| PFAccountManagementBanRequest | PFAccountManagementBanRequest data model. Represents a single ban request. |
| PFAccountManagementBanUsersRequest | PFAccountManagementBanUsersRequest data model. The existence of each user will not be verified. When banning by IP, multiple players may be affected, so use this feature with caution. Returns information about the new bans. |
| PFAccountManagementBanUsersResult | PFAccountManagementBanUsersResult data model. |
| PFAccountManagementClientLinkNintendoServiceAccountRequest | PFAccountManagementClientLinkNintendoServiceAccountRequest data model. |
| PFAccountManagementClientLinkNintendoSwitchDeviceIdRequest | PFAccountManagementClientLinkNintendoSwitchDeviceIdRequest data model. |
| PFAccountManagementClientLinkPSNAccountRequest | PFAccountManagementClientLinkPSNAccountRequest data model. |
| PFAccountManagementClientLinkXboxAccountRequest | PFAccountManagementClientLinkXboxAccountRequest data model. |
| PFAccountManagementClientUnlinkNintendoServiceAccountRequest | PFAccountManagementClientUnlinkNintendoServiceAccountRequest data model. |
| PFAccountManagementClientUnlinkNintendoSwitchDeviceIdRequest | PFAccountManagementClientUnlinkNintendoSwitchDeviceIdRequest data model. |
| PFAccountManagementClientUnlinkPSNAccountRequest | PFAccountManagementClientUnlinkPSNAccountRequest data model. |
| PFAccountManagementClientUnlinkXboxAccountRequest | PFAccountManagementClientUnlinkXboxAccountRequest data model. |
| PFAccountManagementClientUpdateAvatarUrlRequest | PFAccountManagementClientUpdateAvatarUrlRequest data model. |
| PFAccountManagementDeletePlayerRequest | PFAccountManagementDeletePlayerRequest data model. Deletes all data associated with the player, including statistics, custom data, inventory, purchases, virtual currency balances, characters and shared group memberships. Removes the player from all leaderboards and player search indexes. Does not delete PlayStream event history associated with the player. Does not delete the publisher user account that created the player in the title nor associated data such as username, password, email address, account linkages, or friends list. Note, this API queues the player for deletion and returns immediately. It may take several minutes or more before all player data is fully deleted. Until the player data is fully deleted, attempts to recreate the player with the same user account in the same title will fail with the ‘AccountDeleted’ error. This API must be enabled for use as an option in the game manager website. It is disabled by default. |
| PFAccountManagementFacebookInstantGamesPlayFabIdPair | PFAccountManagementFacebookInstantGamesPlayFabIdPair data model. |
| PFAccountManagementFacebookPlayFabIdPair | PFAccountManagementFacebookPlayFabIdPair data model. |
| PFAccountManagementGameCenterPlayFabIdPair | PFAccountManagementGameCenterPlayFabIdPair data model. |
| PFAccountManagementGetAccountInfoRequest | PFAccountManagementGetAccountInfoRequest data model. |
| PFAccountManagementGetAccountInfoResult | PFAccountManagementGetAccountInfoResult data model. This API retrieves details regarding the player in the PlayFab service. Note that when this call is used to retrieve data about another player (not the one signed into the local client), some data, such as Personally Identifying Information (PII), will be omitted for privacy reasons or to comply with the requirements of the platform belongs to. The user account returned will be based on the identifier provided in priority order: PlayFabId, Username, Email, then TitleDisplayName. If no identifier is specified, the currently signed in user’s information will be returned. |
| PFAccountManagementGetPlayerCombinedInfoRequest | PFAccountManagementGetPlayerCombinedInfoRequest data model. |
| PFAccountManagementGetPlayerCombinedInfoResult | PFAccountManagementGetPlayerCombinedInfoResult data model. Returns whatever info is requested in the response for the user. If no user is explicitly requested this defaults to the authenticated user. If the user is the same as the requester, PII (like email address, facebook id) is returned if available. Otherwise, only public information is returned. All parameters default to false. |
| PFAccountManagementGetPlayerProfileRequest | PFAccountManagementGetPlayerProfileRequest data model. This API allows for access to details regarding a user in the PlayFab service, usually for purposes of customer support. Note that data returned may be Personally Identifying Information (PII), such as email address, and so care should be taken in how this data is stored and managed. Since this call will always return the relevant information for users who have accessed the title, the recommendation is to not store this data locally. |
| PFAccountManagementGetPlayerProfileResult | PFAccountManagementGetPlayerProfileResult data model. |
| PFAccountManagementGetPlayFabIDsFromFacebookIDsRequest | PFAccountManagementGetPlayFabIDsFromFacebookIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromFacebookIDsResult | PFAccountManagementGetPlayFabIDsFromFacebookIDsResult data model. For Facebook identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsRequest | PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsResult | PFAccountManagementGetPlayFabIDsFromFacebookInstantGamesIdsResult data model. For Facebook Instant Game identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromGameCenterIDsRequest | PFAccountManagementGetPlayFabIDsFromGameCenterIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromGameCenterIDsResult | PFAccountManagementGetPlayFabIDsFromGameCenterIDsResult data model. For Game Center identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromGoogleIDsRequest | PFAccountManagementGetPlayFabIDsFromGoogleIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromGoogleIDsResult | PFAccountManagementGetPlayFabIDsFromGoogleIDsResult data model. For Google identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest | PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsResult | PFAccountManagementGetPlayFabIDsFromGooglePlayGamesPlayerIDsResult data model. For Google Play Games identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromKongregateIDsRequest | PFAccountManagementGetPlayFabIDsFromKongregateIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromKongregateIDsResult | PFAccountManagementGetPlayFabIDsFromKongregateIDsResult data model. For Kongregate identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsRequest | PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsResult | PFAccountManagementGetPlayFabIDsFromNintendoServiceAccountIdsResult data model. For Nintendo Service Account identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsRequest | PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsResult | PFAccountManagementGetPlayFabIDsFromNintendoSwitchDeviceIdsResult data model. For Nintendo Switch identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromPSNAccountIDsRequest | PFAccountManagementGetPlayFabIDsFromPSNAccountIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromPSNAccountIDsResult | PFAccountManagementGetPlayFabIDsFromPSNAccountIDsResult data model. For PlayStation :tm: Network identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromSteamIDsRequest | PFAccountManagementGetPlayFabIDsFromSteamIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromSteamIDsResult | PFAccountManagementGetPlayFabIDsFromSteamIDsResult data model. For Steam identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromTwitchIDsRequest | PFAccountManagementGetPlayFabIDsFromTwitchIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromTwitchIDsResult | PFAccountManagementGetPlayFabIDsFromTwitchIDsResult data model. For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetPlayFabIDsFromXboxLiveIDsRequest | PFAccountManagementGetPlayFabIDsFromXboxLiveIDsRequest data model. |
| PFAccountManagementGetPlayFabIDsFromXboxLiveIDsResult | PFAccountManagementGetPlayFabIDsFromXboxLiveIDsResult data model. For XboxLive identifiers which have not been linked to PlayFab accounts, null will be returned. |
| PFAccountManagementGetServerCustomIDsFromPlayFabIDsRequest | PFAccountManagementGetServerCustomIDsFromPlayFabIDsRequest data model. |
| PFAccountManagementGetServerCustomIDsFromPlayFabIDsResult | PFAccountManagementGetServerCustomIDsFromPlayFabIDsResult data model. For a PlayFab account that isn’t associated with a server custom identity, ServerCustomId will be null. |
| PFAccountManagementGetTitlePlayersFromProviderIDsResponse | PFAccountManagementGetTitlePlayersFromProviderIDsResponse data model. |
| PFAccountManagementGetTitlePlayersFromXboxLiveIDsRequest | PFAccountManagementGetTitlePlayersFromXboxLiveIDsRequest data model. Given a collection of XBOX IDs (XUIDs), returns all title player accounts. |
| PFAccountManagementGetUserAccountInfoRequest | PFAccountManagementGetUserAccountInfoRequest data model. This API allows for access to details regarding a user in the PlayFab service, usually for purposes of customer support. Note that data returned may be Personally Identifying Information (PII), such as email address, and so care should be taken in how this data is stored and managed. Since this call will always return the relevant information for users who have accessed the title, the recommendation is to not store this data locally. |
| PFAccountManagementGetUserAccountInfoResult | PFAccountManagementGetUserAccountInfoResult data model. |
| PFAccountManagementGetUserBansRequest | PFAccountManagementGetUserBansRequest data model. Get all bans for a user, including inactive and expired bans. . |
| PFAccountManagementGetUserBansResult | PFAccountManagementGetUserBansResult data model. |
| PFAccountManagementGooglePlayFabIdPair | PFAccountManagementGooglePlayFabIdPair data model. |
| PFAccountManagementGooglePlayGamesPlayFabIdPair | PFAccountManagementGooglePlayGamesPlayFabIdPair data model. |
| PFAccountManagementKongregatePlayFabIdPair | PFAccountManagementKongregatePlayFabIdPair data model. |
| PFAccountManagementLinkAndroidDeviceIDRequest | PFAccountManagementLinkAndroidDeviceIDRequest data model. |
| PFAccountManagementLinkAppleRequest | PFAccountManagementLinkAppleRequest data model. |
| PFAccountManagementLinkCustomIDRequest | PFAccountManagementLinkCustomIDRequest data model. |
| PFAccountManagementLinkFacebookAccountRequest | PFAccountManagementLinkFacebookAccountRequest data model. Facebook sign-in is accomplished using the Facebook User Access Token. More information on the Token can be found in the Facebook developer documentation (https://developers.facebook.com/docs/facebook-login/access-tokens/). In Unity, for example, the Token is available as AccessToken in the Facebook SDK ScriptableObject FB. Note that titles should never re-use the same Facebook applications between PlayFab Title IDs, as Facebook provides unique user IDs per application and doing so can result in issues with the Facebook ID for the user in their PlayFab account information. If you must re-use an application in a new PlayFab Title ID, please be sure to first unlink all accounts from Facebook, or delete all users in the first Title ID. |
| PFAccountManagementLinkFacebookInstantGamesIdRequest | PFAccountManagementLinkFacebookInstantGamesIdRequest data model. |
| PFAccountManagementLinkGameCenterAccountRequest | PFAccountManagementLinkGameCenterAccountRequest data model. |
| PFAccountManagementLinkGoogleAccountRequest | PFAccountManagementLinkGoogleAccountRequest data model. Google sign-in is accomplished by obtaining a Google OAuth 2.0 credential using the Google sign-in for Android APIs on the device and passing it to this API. |
| PFAccountManagementLinkGooglePlayGamesServicesAccountRequest | PFAccountManagementLinkGooglePlayGamesServicesAccountRequest data model. Google Play Games sign-in is accomplished by obtaining a Google OAuth 2.0 credential using the Google Play Games sign-in for Android APIs on the device and passing it to this API. |
| PFAccountManagementLinkIOSDeviceIDRequest | PFAccountManagementLinkIOSDeviceIDRequest data model. |
| PFAccountManagementLinkKongregateAccountRequest | PFAccountManagementLinkKongregateAccountRequest data model. |
| PFAccountManagementLinkNintendoServiceAccountSubjectRequest | PFAccountManagementLinkNintendoServiceAccountSubjectRequest data model. |
| PFAccountManagementLinkOpenIdConnectRequest | PFAccountManagementLinkOpenIdConnectRequest data model. |
| PFAccountManagementLinkServerCustomIdRequest | PFAccountManagementLinkServerCustomIdRequest data model. |
| PFAccountManagementLinkSteamAccountRequest | PFAccountManagementLinkSteamAccountRequest data model. Steam authentication is accomplished with the Steam Session Ticket. More information on the Ticket can be found in the Steamworks SDK, here: https://partner.steamgames.com/documentation/auth (requires sign-in). NOTE: For Steam authentication to work, the title must be configured with the Steam Application ID and Publisher Key in the PlayFab Game Manager (under Properties). Information on creating a Publisher Key (referred to as the Secret Key in PlayFab) for your title can be found here: https://partner.steamgames.com/documentation/webapi#publisherkey. |
| PFAccountManagementLinkSteamIdRequest | PFAccountManagementLinkSteamIdRequest data model. |
| PFAccountManagementLinkTwitchAccountRequest | PFAccountManagementLinkTwitchAccountRequest data model. |
| PFAccountManagementNintendoServiceAccountPlayFabIdPair | PFAccountManagementNintendoServiceAccountPlayFabIdPair data model. |
| PFAccountManagementNintendoSwitchPlayFabIdPair | PFAccountManagementNintendoSwitchPlayFabIdPair data model. |
| PFAccountManagementPSNAccountPlayFabIdPair | PFAccountManagementPSNAccountPlayFabIdPair data model. |
| PFAccountManagementPSNOnlinePlayFabIdPair | PFAccountManagementPSNOnlinePlayFabIdPair data model. |
| PFAccountManagementRemoveContactEmailRequest | PFAccountManagementRemoveContactEmailRequest data model. This API removes an existing contact email from the player’s profile. |
| PFAccountManagementReportPlayerClientRequest | PFAccountManagementReportPlayerClientRequest data model. |
| PFAccountManagementReportPlayerClientResult | PFAccountManagementReportPlayerClientResult data model. Players are currently limited to five reports per day. Attempts by a single user account to submit reports beyond five will result in Updated being returned as false. |
| PFAccountManagementRevokeAllBansForUserRequest | PFAccountManagementRevokeAllBansForUserRequest data model. Setting the active state of all non-expired bans for a user to Inactive. Expired bans with an Active state will be ignored, however. Returns information about applied updates only. |
| PFAccountManagementRevokeAllBansForUserResult | PFAccountManagementRevokeAllBansForUserResult data model. |
| PFAccountManagementRevokeBansRequest | PFAccountManagementRevokeBansRequest data model. Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired. BanIds that do not exist will be skipped. Returns information about applied updates only. . |
| PFAccountManagementRevokeBansResult | PFAccountManagementRevokeBansResult data model. |
| PFAccountManagementSendAccountRecoveryEmailRequest | PFAccountManagementSendAccountRecoveryEmailRequest data model. If the account in question is a “temporary” account (for example, one that was created via a call to LoginFromIOSDeviceID), thisfunction will have no effect. Only PlayFab accounts which have valid email addresses will be able to receive a password reset email using this API. |
| PFAccountManagementSendCustomAccountRecoveryEmailRequest | PFAccountManagementSendCustomAccountRecoveryEmailRequest data model. PlayFab accounts which have valid email address or username will be able to receive a password reset email using this API.The email sent must be an account recovery email template. The username or email can be passed in to send the email. |
| PFAccountManagementSendEmailFromTemplateRequest | PFAccountManagementSendEmailFromTemplateRequest data model. Sends an email for only players that have contact emails associated with them. Takes in an email template ID specifyingthe email template to send. |
| PFAccountManagementServerCustomIDPlayFabIDPair | PFAccountManagementServerCustomIDPlayFabIDPair data model. |
| PFAccountManagementServerLinkNintendoServiceAccountRequest | PFAccountManagementServerLinkNintendoServiceAccountRequest data model. |
| PFAccountManagementServerLinkNintendoSwitchDeviceIdRequest | PFAccountManagementServerLinkNintendoSwitchDeviceIdRequest data model. |
| PFAccountManagementServerLinkPSNAccountRequest | PFAccountManagementServerLinkPSNAccountRequest data model. |
| PFAccountManagementServerLinkXboxAccountRequest | PFAccountManagementServerLinkXboxAccountRequest data model. |
| PFAccountManagementServerUnlinkNintendoServiceAccountRequest | PFAccountManagementServerUnlinkNintendoServiceAccountRequest data model. |
| PFAccountManagementServerUnlinkNintendoSwitchDeviceIdRequest | PFAccountManagementServerUnlinkNintendoSwitchDeviceIdRequest data model. |
| PFAccountManagementServerUnlinkPSNAccountRequest | PFAccountManagementServerUnlinkPSNAccountRequest data model. |
| PFAccountManagementServerUnlinkXboxAccountRequest | PFAccountManagementServerUnlinkXboxAccountRequest data model. |
| PFAccountManagementServerUpdateAvatarUrlRequest | PFAccountManagementServerUpdateAvatarUrlRequest data model. |
| PFAccountManagementSteamPlayFabIdPair | PFAccountManagementSteamPlayFabIdPair data model. |
| PFAccountManagementTwitchPlayFabIdPair | PFAccountManagementTwitchPlayFabIdPair data model. |
| PFAccountManagementUnlinkAndroidDeviceIDRequest | PFAccountManagementUnlinkAndroidDeviceIDRequest data model. |
| PFAccountManagementUnlinkAppleRequest | PFAccountManagementUnlinkAppleRequest data model. |
| PFAccountManagementUnlinkCustomIDRequest | PFAccountManagementUnlinkCustomIDRequest data model. |
| PFAccountManagementUnlinkFacebookAccountRequest | PFAccountManagementUnlinkFacebookAccountRequest data model. |
| PFAccountManagementUnlinkFacebookInstantGamesIdRequest | PFAccountManagementUnlinkFacebookInstantGamesIdRequest data model. |
| PFAccountManagementUnlinkGameCenterAccountRequest | PFAccountManagementUnlinkGameCenterAccountRequest data model. |
| PFAccountManagementUnlinkGoogleAccountRequest | PFAccountManagementUnlinkGoogleAccountRequest data model. |
| PFAccountManagementUnlinkGooglePlayGamesServicesAccountRequest | PFAccountManagementUnlinkGooglePlayGamesServicesAccountRequest data model. |
| PFAccountManagementUnlinkIOSDeviceIDRequest | PFAccountManagementUnlinkIOSDeviceIDRequest data model. |
| PFAccountManagementUnlinkKongregateAccountRequest | PFAccountManagementUnlinkKongregateAccountRequest data model. |
| PFAccountManagementUnlinkOpenIdConnectRequest | PFAccountManagementUnlinkOpenIdConnectRequest data model. |
| PFAccountManagementUnlinkServerCustomIdRequest | PFAccountManagementUnlinkServerCustomIdRequest data model. |
| PFAccountManagementUnlinkSteamAccountRequest | PFAccountManagementUnlinkSteamAccountRequest data model. |
| PFAccountManagementUnlinkSteamIdRequest | PFAccountManagementUnlinkSteamIdRequest data model. |
| PFAccountManagementUnlinkTwitchAccountRequest | PFAccountManagementUnlinkTwitchAccountRequest data model. |
| PFAccountManagementUpdateBanRequest | PFAccountManagementUpdateBanRequest data model. Represents a single update ban request. |
| PFAccountManagementUpdateBansRequest | PFAccountManagementUpdateBansRequest data model. For each ban, only updates the values that are set. Leave any value to null for no change. If a ban could not be found, the rest are still applied. Returns information about applied updates only. |
| PFAccountManagementUpdateBansResult | PFAccountManagementUpdateBansResult data model. |
| PFAccountManagementUpdateUserTitleDisplayNameRequest | PFAccountManagementUpdateUserTitleDisplayNameRequest data model. In addition to the PlayFab username, titles can make use of a DisplayName which is also a unique identifier, but specific to the title. This allows for unique names which more closely match the theme or genre of a title, for example. |
| PFAccountManagementUpdateUserTitleDisplayNameResult | PFAccountManagementUpdateUserTitleDisplayNameResult data model. |
| PFAccountManagementXboxLiveAccountPlayFabIdPair | PFAccountManagementXboxLiveAccountPlayFabIdPair data model. |