Authentication - Login With OpenId Connect

LoginResult

ApiErrorWrapper

This is the outer wrapper for all responses with errors

string

UTC time stamp of attribution

string

Attribution campaign identifier

string

Attribution network name

integer

Numerical HTTP code

string

Playfab error code

integer

Numerical PlayFab error code

object

Detailed description of individual issues with the request object

string

Description for the PlayFab errorCode

string

String HTTP code

string

The id of this character.

ItemInstance[]

The inventory of this character.

string

The id for this character on this player.

string

The name of this character.

string

The type-string that was given to this character on creation.

string

The email address

string

The name of the email info data

EmailVerificationStatus

The verification status of the email

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

Unique ID of the entity.

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

EntityKey

The entity id and type.

string

The token used to set X-EntityToken for all entity based API calls.

string

The time the token will expire, if it is an expiring token, in UTC.

boolean

Whether to get character inventories. Defaults to false.

boolean

Whether to get the list of characters. Defaults to false.

boolean

Whether to get player profile. Defaults to false. Has no effect for a new player.

boolean

Whether to get player statistics. Defaults to false.

boolean

Whether to get title data. Defaults to false.

boolean

Whether to get the player's account Info. Defaults to false

boolean

Whether to get the player's custom data. Defaults to false

boolean

Whether to get the player's inventory. Defaults to false

boolean

Whether to get the player's read only data. Defaults to false

boolean

Whether to get the player's virtual currency balances. Defaults to false

string[]

Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false

PlayerProfileViewConstraints

Specifies the properties to return from the player profile. Defaults to returning the player's display name.

string[]

Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false

string[]

Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false

string[]

Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserReadOnlyData is false

UserAccountInfo

Account information for the user. This is always retrieved.

CharacterInventory[]

Inventories for each character for the user.

CharacterResult[]

List of characters for the user.

PlayerProfileModel

The profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not exist.

StatisticValue[]

List of statistics for this player.

object

Title data for this title.

UserDataRecord

User specific custom data.

number

The version of the UserData that was returned.

ItemInstance[]

Array of inventory items in the user's current inventory.

UserDataRecord

User specific read-only data.

number

The version of the Read-Only UserData that was returned.

object

Dictionary of virtual currency balance(s) belonging to the user.

VirtualCurrencyRechargeTime

Dictionary of remaining times and timestamps for virtual currencies.

string

Game specific comment associated with this instance when it was added to the user inventory.

string[]

Array of unique items that were awarded when this catalog item was purchased.

string

Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or container.

string

Catalog version for the inventory item, when this instance was created.

object

A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog item's custom data.

string

CatalogItem.DisplayName at the time this item was purchased.

string

Timestamp for when this instance will expire.

string

Class name for the inventory item, as defined in the catalog.

string

Unique identifier for the inventory item, as defined in the catalog.

string

Unique item identifier for this specific instance of the item.

string

Timestamp for when this instance was purchased.

number

Total number of remaining uses, if this is a consumable item.

string

Currency type for the cost of the catalog item. Not available when granting items.

number

Cost of the catalog item in the given currency. Not available when granting items.

number

The number of uses that were added or removed to this item in this call.

string

Linked account email of the user on the platform, if available

LoginIdentityProvider

Authentication platform

string

Unique account identifier of the user on the platform

string

Linked account username of the user on the platform, if available

string

City name.

ContinentCode

The two-character continent code for this location

CountryCode

The two-character ISO 3166-1 country code for the country associated with the location

number

Latitude coordinate of the geographic location.

number

Longitude coordinate of the geographic location.

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

EntityTokenResponse

If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and returned.

GetPlayerCombinedInfoResultPayload

Results for requested info.

string

The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue

boolean

True if the account was newly created on this login.

string

Player's unique PlayFabId.

string

Unique token authorizing the user and game at the server level, for the current session.

UserSettings

Settings specific to this user.

TreatmentAssignment

The experimentation treatments for this user at the time of login.

string

A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters.

boolean

Automatically create a PlayFab account if one is not currently linked to this ID.

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

string

Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).

string

The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the identity provider's response.

GetPlayerCombinedInfoRequestParams

Flags for which pieces of info to return for the user.

string

Player secret that is used to verify API request signatures (Enterprise Only).

string

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

boolean

Whether this membership is active. That is, whether the MembershipExpiration time has been reached.

string

The time this membership expires

string

The id of the membership

string

Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been overridden, this will be the new expiration time.

boolean

Whether the override expiration is set.

SubscriptionModel[]

The list of subscriptions that this player has for this membership

AdCampaignAttributionModel[]

List of advertising campaigns the player has been attributed to

string

URL of the player's avatar image

string

If the player is currently banned, the UTC Date when the ban expires

ContactEmailInfoModel[]

List of all contact email info associated with the player account

string

Player record created

string

Player display name

string[]

List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment property during login to get the correct variants and variables.

string

UTC time when the player most recently logged in to the title

LinkedPlatformAccountModel[]

List of all authentication systems linked to this player account

LocationModel[]

List of geographic locations from which the player has logged in to the title

MembershipModel[]

List of memberships for the player, along with whether are expired.

LoginIdentityProvider

Player account origination

string

PlayFab player account unique identifier

string

Publisher this player belongs to

PushNotificationRegistrationModel[]

List of configured end points registered for sending the player push notifications

StatisticModel[]

List of leaderboard statistic values for the player

TagModel[]

List of player's tags for segmentation

string

Title ID this player profile applies to

number

Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.

ValueToDateModel[]

List of the player's lifetime purchase totals, summed by real-money currency

boolean

Whether to show player's avatar URL. Defaults to false

boolean

Whether to show the banned until time. Defaults to false

boolean

Whether to show campaign attributions. Defaults to false

boolean

Whether to show contact email addresses. Defaults to false

boolean

Whether to show the created date. Defaults to false

boolean

Whether to show the display name. Defaults to false

boolean

Whether to show player's experiment variants. Defaults to false

boolean

Whether to show the last login time. Defaults to false

boolean

Whether to show the linked accounts. Defaults to false

boolean

Whether to show player's locations. Defaults to false

boolean

Whether to show player's membership information. Defaults to false

boolean

Whether to show origination. Defaults to false

boolean

Whether to show push notification registrations. Defaults to false

boolean

Reserved for future development

boolean

Whether to show tags. Defaults to false

boolean

Whether to show the total value to date in usd. Defaults to false

boolean

Whether to show the values to date. Defaults to false

string

string

string

Notification configured endpoint

PushNotificationPlatform

Push notification platform

string

Statistic name

number

Statistic value

number

Statistic version (0 if not a versioned statistic)

string

unique name of the statistic

number

statistic value for the player

number

for updates to an existing statistic value for a player, the version of the statistic when it was loaded

string

When this subscription expires.

string

The time the subscription was orignially purchased

boolean

Whether this subscription is currently active. That is, if Expiration > now.

SubscriptionProviderStatus

The status of this subscription, according to the subscription provider.

string

The id for this subscription

string

The item id for this subscription from the primary catalog

string

The provider for this subscription. Apple or Google Play are supported today.

string

string

string

string

string

string

string

string

string

Full value of the tag, including namespace

string

string

string

string

string

Variable[]

List of the experiment variables.

string[]

List of the experiment variants.

UserAndroidDeviceInfo

User Android device information, if an Android device has been linked

UserAppleIdInfo

Sign in with Apple account information, if an Apple account has been linked

string

Timestamp indicating when the user account was created

UserCustomIdInfo

Custom ID information, if a custom ID has been assigned

UserFacebookInfo

User Facebook information, if a Facebook account has been linked

UserFacebookInstantGamesIdInfo

Facebook Instant Games account information, if a Facebook Instant Games account has been linked

UserGameCenterInfo

User Gamecenter information, if a Gamecenter account has been linked

UserGoogleInfo

User Google account information, if a Google account has been linked

UserGooglePlayGamesInfo

User Google Play Games account information, if a Google Play Games account has been linked

UserIosDeviceInfo

User iOS device information, if an iOS device has been linked

UserKongregateInfo

User Kongregate account information, if a Kongregate account has been linked

UserNintendoSwitchAccountIdInfo

Nintendo Switch account information, if a Nintendo Switch account has been linked

UserNintendoSwitchDeviceIdInfo

Nintendo Switch device information, if a Nintendo Switch device has been linked

UserOpenIdInfo[]

OpenID Connect information, if any OpenID Connect accounts have been linked

string

Unique identifier for the user account

UserPrivateAccountInfo

Personal information for the user which is considered more sensitive

UserPsnInfo

User PlayStation ™️ Network account information, if a PlayStation ™️ Network account has been linked

UserServerCustomIdInfo

Server Custom ID information, if a server custom ID has been assigned

UserSteamInfo

User Steam information, if a Steam account has been linked

UserTitleInfo

Title-specific information for the user account

UserTwitchInfo

User Twitch account information, if a Twitch account has been linked

string

User account name in the PlayFab service

UserXboxInfo

User XBox account information, if a XBox account has been linked

string

Android device ID

string

Apple subject ID

string

Custom ID

string

string

string

Timestamp for when this data was last updated.

UserDataPermission

Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData requests being made by one player about another player.

string

Data stored for the specified user data key.

string

Facebook identifier

string

Facebook full name

string

Facebook Instant Games ID

string

Gamecenter identifier

string

Email address of the Google account

string

Gender information of the Google account

string

Google ID

string

Locale of the Google account

string

Name of the Google account user

string

Avatar image url of the Google Play Games player

string

Display name of the Google Play Games player

string

Google Play Games player ID

string

iOS device ID

string

Kongregate ID

string

Kongregate Username

string

Nintendo Switch account subject ID

string

Nintendo Switch Device ID

string

OpenID Connection ID

string

OpenID Issuer

string

OpenID Subject

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

user email address

string

PlayStation ™️ Network account ID

string

PlayStation ™️ Network online ID

string

Custom ID

boolean

Boolean for whether this player is eligible for gathering device info.

boolean

Boolean for whether this player should report OnFocus play-time tracking.

boolean

Boolean for whether this player is eligible for ad tracking.

TitleActivationStatus

what stage of game ownership the user is listed as being in, from Steam

string

the country in which the player resides, from Steam data

Currency

currency type set in the user Steam account

string

Steam identifier

string

Steam display name

string

URL to the player's avatar.

string

timestamp indicating when the user was first associated with this game (this can differ significantly from when the user first registered with PlayFab)

string

name of the user, as it is displayed in-game

string

timestamp indicating when the user first signed into this game (this can differ from the Created timestamp, as other events, such as issuing a beta key to the user, can associate the title to the user)

string

timestamp for the last user login for this title

UserOrigination

source by which the user first joined the game, if known

EntityKey

Title player account entity for this user

boolean

boolean indicating whether or not the user is currently banned for a title

string

Twitch ID

string

Twitch Username

string

XBox user ID

string

XBox user sandbox

string

ISO 4217 code of the currency used in the purchases

number

Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and ninety-nine cents when Currency is 'USD')

string

Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine dollars and ninety-nine cents when Currency is 'USD'.

string

Name of the variable.

string

Value of the variable.

number

Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen below this value.

string

Server timestamp in UTC indicating the next time the virtual currency will be incremented.

number

Time remaining (in seconds) before the next recharge increment of the virtual currency.