Authentication - Login With Custom ID

Service:

Client

API Version:

250228

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

POST https://titleId.playfabapi.com/Client/LoginWithCustomID

Request Header

Name	Required	Type	Description
None	True	string	This API requires no authentication headers (usually provides one to other calls).

Request Body

Name	Required	Type	Description
TitleId	True	string	Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.
CreateAccount		boolean	Automatically create a PlayFab account if one is not currently linked to this ID.
CustomId		string	Custom unique identifier for the user, generated by the title.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EncryptedRequest		string	Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).
InfoRequestParameters		GetPlayerCombinedInfoRequestParams	Flags for which pieces of info to return for the user.
PlayerSecret		string	Player secret that is used to verify API request signatures (Enterprise Only).

Responses

Name	Type	Description
200 OK	LoginResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

None

This API requires no authentication headers (usually provides one to other calls).

Type: apiKey
In: header

Definitions

Name	Description
AdCampaignAttributionModel
ApiErrorWrapper	The basic wrapper around every failed API response
CharacterInventory
CharacterResult
ContactEmailInfoModel
ContinentCode
CountryCode
Currency
EmailVerificationStatus
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
EntityTokenResponse
GetPlayerCombinedInfoRequestParams
GetPlayerCombinedInfoResultPayload
ItemInstance	A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.
LinkedPlatformAccountModel
LocationModel
LoginIdentityProvider
LoginResult
LoginWithCustomIDRequest	It is highly recommended that developers ensure that it is extremely unlikely that a customer could generate an ID which is already in use by another customer. If this is the first time a user has signed in with the Custom ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Custom ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Custom ID, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.
MembershipModel
PlayerProfileModel
PlayerProfileViewConstraints
PushNotificationPlatform
PushNotificationRegistrationModel
StatisticModel
StatisticValue
SubscriptionModel
SubscriptionProviderStatus
TagModel
TitleActivationStatus
TreatmentAssignment
UserAccountInfo
UserAndroidDeviceInfo
UserAppleIdInfo
UserCustomIdInfo
UserDataPermission	Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.
UserDataRecord
UserFacebookInfo
UserFacebookInstantGamesIdInfo
UserGameCenterInfo
UserGoogleInfo
UserGooglePlayGamesInfo
UserIosDeviceInfo
UserKongregateInfo
UserNintendoSwitchAccountIdInfo
UserNintendoSwitchDeviceIdInfo
UserOpenIdInfo
UserOrigination
UserPrivateAccountInfo
UserPsnInfo
UserServerCustomIdInfo
UserSettings
UserSteamInfo
UserTitleInfo
UserTwitchInfo
UserXboxInfo
ValueToDateModel
Variable
VirtualCurrencyRechargeTime

AdCampaignAttributionModel

Object

Name	Type	Description
AttributedAt	string	UTC time stamp of attribution
CampaignId	string	Attribution campaign identifier
Platform	string	Attribution network name

ApiErrorWrapper

Object

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

CharacterInventory

Object

Name	Type	Description
CharacterId	string	The id of this character.
Inventory	ItemInstance[]	The inventory of this character.

CharacterResult

Object

Name	Type	Description
CharacterId	string	The id for this character on this player.
CharacterName	string	The name of this character.
CharacterType	string	The type-string that was given to this character on creation.

ContactEmailInfoModel

Object

Name	Type	Description
EmailAddress	string	The email address
Name	string	The name of the email info data
VerificationStatus	EmailVerificationStatus	The verification status of the email

ContinentCode

Enumeration

Value	Description
AF
AN
AS
EU
NA
OC
SA
Unknown

CountryCode

Enumeration

Value	Description
AD
AE
AF
AG
AI
AL
AM
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
Unknown
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW

Currency

Enumeration

Value	Description
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYR
BZD
CAD
CDF
CHF
CLP
CNY
COP
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EGP
ERN
ETB
EUR
FJD
FKP
GBP
GEL
GGP
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
IMP
INR
IQD
IRR
ISK
JEP
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SPL
SRD
STD
SVC
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TVD
TWD
TZS
UAH
UGX
USD
UYU
UZS
VEF
VND
VUV
WST
XAF
XCD
XDR
XOF
XPF
YER
ZAR
ZMW
ZWD

EmailVerificationStatus

Enumeration

Value	Description
Confirmed
Pending
Unverified

EntityKey

Object

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

EntityTokenResponse

Object

Name	Type	Description
Entity	EntityKey	The entity id and type.
EntityToken	string	The token used to set X-EntityToken for all entity based API calls.
TokenExpiration	string	The time the token will expire, if it is an expiring token, in UTC.

GetPlayerCombinedInfoRequestParams

Object

Name	Type	Description
GetCharacterInventories	boolean	Whether to get character inventories. Defaults to false.
GetCharacterList	boolean	Whether to get the list of characters. Defaults to false.
GetPlayerProfile	boolean	Whether to get player profile. Defaults to false. Has no effect for a new player.
GetPlayerStatistics	boolean	Whether to get player statistics. Defaults to false.
GetTitleData	boolean	Whether to get title data. Defaults to false.
GetUserAccountInfo	boolean	Whether to get the player's account Info. Defaults to false
GetUserData	boolean	Whether to get the player's custom data. Defaults to false
GetUserInventory	boolean	Whether to get the player's inventory. Defaults to false
GetUserReadOnlyData	boolean	Whether to get the player's read only data. Defaults to false
GetUserVirtualCurrency	boolean	Whether to get the player's virtual currency balances. Defaults to false
PlayerStatisticNames	string[]	Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false
ProfileConstraints	PlayerProfileViewConstraints	Specifies the properties to return from the player profile. Defaults to returning the player's display name.
TitleDataKeys	string[]	Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false
UserDataKeys	string[]	Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false
UserReadOnlyDataKeys	string[]	Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserReadOnlyData is false

GetPlayerCombinedInfoResultPayload

Object

Name	Type	Description
AccountInfo	UserAccountInfo	Account information for the user. This is always retrieved.
CharacterInventories	CharacterInventory[]	Inventories for each character for the user.
CharacterList	CharacterResult[]	List of characters for the user.
PlayerProfile	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.
PlayerStatistics	StatisticValue[]	List of statistics for this player.
TitleData	object	Title data for this title.
UserData	UserDataRecord	User specific custom data.
UserDataVersion	number	The version of the UserData that was returned.
UserInventory	ItemInstance[]	Array of inventory items in the user's current inventory.
UserReadOnlyData	UserDataRecord	User specific read-only data.
UserReadOnlyDataVersion	number	The version of the Read-Only UserData that was returned.
UserVirtualCurrency	object	Dictionary of virtual currency balance(s) belonging to the user.
UserVirtualCurrencyRechargeTimes	VirtualCurrencyRechargeTime	Dictionary of remaining times and timestamps for virtual currencies.

ItemInstance

Object

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.

Name	Type	Description
Annotation	string	Game specific comment associated with this instance when it was added to the user inventory.
BundleContents	string[]	Array of unique items that were awarded when this catalog item was purchased.
BundleParent	string	Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or container.
CatalogVersion	string	Catalog version for the inventory item, when this instance was created.
CustomData	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.
DisplayName	string	CatalogItem.DisplayName at the time this item was purchased.
Expiration	string	Timestamp for when this instance will expire.
ItemClass	string	Class name for the inventory item, as defined in the catalog.
ItemId	string	Unique identifier for the inventory item, as defined in the catalog.
ItemInstanceId	string	Unique item identifier for this specific instance of the item.
PurchaseDate	string	Timestamp for when this instance was purchased.
RemainingUses	number	Total number of remaining uses, if this is a consumable item.
UnitCurrency	string	Currency type for the cost of the catalog item. Not available when granting items.
UnitPrice	number	Cost of the catalog item in the given currency. Not available when granting items.
UsesIncrementedBy	number	The number of uses that were added or removed to this item in this call.

LinkedPlatformAccountModel

Object

Name	Type	Description
Email	string	Linked account email of the user on the platform, if available
Platform	LoginIdentityProvider	Authentication platform
PlatformUserId	string	Unique account identifier of the user on the platform
Username	string	Linked account username of the user on the platform, if available

LocationModel

Object

Name	Type	Description
City	string	City name.
ContinentCode	ContinentCode	The two-character continent code for this location
CountryCode	CountryCode	The two-character ISO 3166-1 country code for the country associated with the location
Latitude	number	Latitude coordinate of the geographic location.
Longitude	number	Longitude coordinate of the geographic location.

LoginIdentityProvider

Enumeration

Value	Description
AndroidDevice
Apple
Custom
CustomServer
Facebook
FacebookInstantGames
GameCenter
GameServer
GooglePlay
GooglePlayGames
IOSDevice
King
Kongregate
NintendoSwitch
NintendoSwitchAccount
OpenIdConnect
PSN
PlayFab
Steam
Twitch
Unknown
WindowsHello
XBoxLive
XboxMobileStore

LoginResult

Object

Name	Type	Description
EntityToken	EntityTokenResponse	If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and returned.
InfoResultPayload	GetPlayerCombinedInfoResultPayload	Results for requested info.
LastLoginTime	string	The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue
NewlyCreated	boolean	True if the master_player_account was newly created on this login.
PlayFabId	string	Player's unique PlayFabId.
SessionTicket	string	Unique token authorizing the user and game at the server level, for the current session.
SettingsForUser	UserSettings	Settings specific to this user.
TreatmentAssignment	TreatmentAssignment	The experimentation treatments for this user at the time of login.

LoginWithCustomIDRequest

Object

It is highly recommended that developers ensure that it is extremely unlikely that a customer could generate an ID which is already in use by another customer. If this is the first time a user has signed in with the Custom ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Custom ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Custom ID, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.

Name	Type	Description
CreateAccount	boolean	Automatically create a PlayFab account if one is not currently linked to this ID.
CustomId	string	Custom unique identifier for the user, generated by the title.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EncryptedRequest	string	Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).
InfoRequestParameters	GetPlayerCombinedInfoRequestParams	Flags for which pieces of info to return for the user.
PlayerSecret	string	Player secret that is used to verify API request signatures (Enterprise Only).
TitleId	string	Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

MembershipModel

Object

Name	Type	Description
IsActive	boolean	Whether this membership is active. That is, whether the MembershipExpiration time has been reached.
MembershipExpiration	string	The time this membership expires
MembershipId	string	The id of the membership
OverrideExpiration	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.
OverrideIsSet	boolean	Whether the override expiration is set.
Subscriptions	SubscriptionModel[]	The list of subscriptions that this player has for this membership

PlayerProfileModel

Object

Name	Type	Description
AdCampaignAttributions	AdCampaignAttributionModel[]	List of advertising campaigns the player has been attributed to
AvatarUrl	string	URL of the player's avatar image
BannedUntil	string	If the player is currently banned, the UTC Date when the ban expires
ContactEmailAddresses	ContactEmailInfoModel[]	List of all contact email info associated with the player account
Created	string	Player record created
DisplayName	string	Player display name
ExperimentVariants	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.
LastLogin	string	UTC time when the player most recently logged in to the title
LinkedAccounts	LinkedPlatformAccountModel[]	List of all authentication systems linked to this player account
Locations	LocationModel[]	List of geographic locations from which the player has logged in to the title
Memberships	MembershipModel[]	List of memberships for the player, along with whether are expired.
Origination	LoginIdentityProvider	Player account origination
PlayerId	string	PlayFab player account unique identifier
PublisherId	string	Publisher this player belongs to
PushNotificationRegistrations	PushNotificationRegistrationModel[]	List of configured end points registered for sending the player push notifications
Statistics	StatisticModel[]	List of leaderboard statistic values for the player
Tags	TagModel[]	List of player's tags for segmentation
TitleId	string	Title ID this player profile applies to
TotalValueToDateInUSD	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.
ValuesToDate	ValueToDateModel[]	List of the player's lifetime purchase totals, summed by real-money currency

PlayerProfileViewConstraints

Object

Name	Type	Description
ShowAvatarUrl	boolean	Whether to show player's avatar URL. Defaults to false
ShowBannedUntil	boolean	Whether to show the banned until time. Defaults to false
ShowCampaignAttributions	boolean	Whether to show campaign attributions. Defaults to false
ShowContactEmailAddresses	boolean	Whether to show contact email addresses. Defaults to false
ShowCreated	boolean	Whether to show the created date. Defaults to false
ShowDisplayName	boolean	Whether to show the display name. Defaults to false
ShowExperimentVariants	boolean	Whether to show player's experiment variants. Defaults to false
ShowLastLogin	boolean	Whether to show the last login time. Defaults to false
ShowLinkedAccounts	boolean	Whether to show the linked accounts. Defaults to false
ShowLocations	boolean	Whether to show player's locations. Defaults to false
ShowMemberships	boolean	Whether to show player's membership information. Defaults to false
ShowOrigination	boolean	Whether to show origination. Defaults to false
ShowPushNotificationRegistrations	boolean	Whether to show push notification registrations. Defaults to false
ShowStatistics	boolean	Reserved for future development
ShowTags	boolean	Whether to show tags. Defaults to false
ShowTotalValueToDateInUsd	boolean	Whether to show the total value to date in usd. Defaults to false
ShowValuesToDate	boolean	Whether to show the values to date. Defaults to false

PushNotificationPlatform

Enumeration

Value	Description
ApplePushNotificationService
GoogleCloudMessaging

PushNotificationRegistrationModel

Object

Name	Type	Description
NotificationEndpointARN	string	Notification configured endpoint
Platform	PushNotificationPlatform	Push notification platform

StatisticModel

Object

Name	Type	Description
Name	string	Statistic name
Value	number	Statistic value
Version	number	Statistic version (0 if not a versioned statistic)

StatisticValue

Object

Name	Type	Description
StatisticName	string	unique name of the statistic
Value	number	statistic value for the player
Version	number	for updates to an existing statistic value for a player, the version of the statistic when it was loaded

SubscriptionModel

Object

Name	Type	Description
Expiration	string	When this subscription expires.
InitialSubscriptionTime	string	The time the subscription was orignially purchased
IsActive	boolean	Whether this subscription is currently active. That is, if Expiration > now.
Status	SubscriptionProviderStatus	The status of this subscription, according to the subscription provider.
SubscriptionId	string	The id for this subscription
SubscriptionItemId	string	The item id for this subscription from the primary catalog
SubscriptionProvider	string	The provider for this subscription. Apple or Google Play are supported today.

SubscriptionProviderStatus

Enumeration

Value	Description
BillingError
Cancelled
CustomerDidNotAcceptPriceChange
FreeTrial
NoError
PaymentPending
ProductUnavailable
UnknownError

TagModel

Object

Name	Type	Description
TagValue	string	Full value of the tag, including namespace

TitleActivationStatus

Enumeration

Value	Description
ActivatedSteam
ActivatedTitleKey
None
PendingSteam
RevokedSteam

TreatmentAssignment

Object

Name	Type	Description
Variables	Variable[]	List of the experiment variables.
Variants	string[]	List of the experiment variants.

UserAccountInfo

Object

Name	Type	Description
AndroidDeviceInfo	UserAndroidDeviceInfo	User Android device information, if an Android device has been linked
AppleAccountInfo	UserAppleIdInfo	Sign in with Apple account information, if an Apple account has been linked
Created	string	Timestamp indicating when the user account was created
CustomIdInfo	UserCustomIdInfo	Custom ID information, if a custom ID has been assigned
FacebookInfo	UserFacebookInfo	User Facebook information, if a Facebook account has been linked
FacebookInstantGamesIdInfo	UserFacebookInstantGamesIdInfo	Facebook Instant Games account information, if a Facebook Instant Games account has been linked
GameCenterInfo	UserGameCenterInfo	User Gamecenter information, if a Gamecenter account has been linked
GoogleInfo	UserGoogleInfo	User Google account information, if a Google account has been linked
GooglePlayGamesInfo	UserGooglePlayGamesInfo	User Google Play Games account information, if a Google Play Games account has been linked
IosDeviceInfo	UserIosDeviceInfo	User iOS device information, if an iOS device has been linked
KongregateInfo	UserKongregateInfo	User Kongregate account information, if a Kongregate account has been linked
NintendoSwitchAccountInfo	UserNintendoSwitchAccountIdInfo	Nintendo Switch account information, if a Nintendo Switch account has been linked
NintendoSwitchDeviceIdInfo	UserNintendoSwitchDeviceIdInfo	Nintendo Switch device information, if a Nintendo Switch device has been linked
OpenIdInfo	UserOpenIdInfo[]	OpenID Connect information, if any OpenID Connect accounts have been linked
PlayFabId	string	Unique identifier for the user account
PrivateInfo	UserPrivateAccountInfo	Personal information for the user which is considered more sensitive
PsnInfo	UserPsnInfo	User PlayStation ™️ Network account information, if a PlayStation ™️ Network account has been linked
ServerCustomIdInfo	UserServerCustomIdInfo	Server Custom ID information, if a server custom ID has been assigned
SteamInfo	UserSteamInfo	User Steam information, if a Steam account has been linked
TitleInfo	UserTitleInfo	Title-specific information for the user account
TwitchInfo	UserTwitchInfo	User Twitch account information, if a Twitch account has been linked
Username	string	User account name in the PlayFab service
XboxInfo	UserXboxInfo	User XBox account information, if a XBox account has been linked

UserAndroidDeviceInfo

Object

Name	Type	Description
AndroidDeviceId	string	Android device ID

UserAppleIdInfo

Object

Name	Type	Description
AppleSubjectId	string	Apple subject ID

UserCustomIdInfo

Object

Name	Type	Description
CustomId	string	Custom ID

UserDataPermission

Enumeration

Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.

Value	Description
Private
Public

UserDataRecord

Object

Name	Type	Description
LastUpdated	string	Timestamp for when this data was last updated.
Permission	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.
Value	string	Data stored for the specified user data key.

UserFacebookInfo

Object

Name	Type	Description
FacebookId	string	Facebook identifier
FullName	string	Facebook full name

UserFacebookInstantGamesIdInfo

Object

Name	Type	Description
FacebookInstantGamesId	string	Facebook Instant Games ID

UserGameCenterInfo

Object

Name	Type	Description
GameCenterId	string	Gamecenter identifier

UserGoogleInfo

Object

Name	Type	Description
GoogleEmail	string	Email address of the Google account
GoogleGender	string	Gender information of the Google account
GoogleId	string	Google ID
GoogleLocale	string	Locale of the Google account
GoogleName	string	Name of the Google account user

UserGooglePlayGamesInfo

Object

Name	Type	Description
GooglePlayGamesPlayerAvatarImageUrl	string	Avatar image url of the Google Play Games player
GooglePlayGamesPlayerDisplayName	string	Display name of the Google Play Games player
GooglePlayGamesPlayerId	string	Google Play Games player ID

UserIosDeviceInfo

Object

Name	Type	Description
IosDeviceId	string	iOS device ID

UserKongregateInfo

Object

Name	Type	Description
KongregateId	string	Kongregate ID
KongregateName	string	Kongregate Username

UserNintendoSwitchAccountIdInfo

Object

Name	Type	Description
NintendoSwitchAccountSubjectId	string	Nintendo Switch account subject ID

UserNintendoSwitchDeviceIdInfo

Object

Name	Type	Description
NintendoSwitchDeviceId	string	Nintendo Switch Device ID

UserOpenIdInfo

Object

Name	Type	Description
ConnectionId	string	OpenID Connection ID
Issuer	string	OpenID Issuer
Subject	string	OpenID Subject

UserOrigination

Enumeration

Value	Description
Amazon
Android
Apple
CustomId
Facebook
FacebookInstantGamesId
GameCenter
GamersFirst
Google
GooglePlayGames
IOS
King
Kongregate
LoadTest
NintendoSwitchAccount
NintendoSwitchDeviceId
OpenIdConnect
Organic
PSN
Parse
ServerCustomId
Steam
Twitch
Unknown
XboxLive
XboxMobileStore

UserPrivateAccountInfo

Object

Name	Type	Description
Email	string	user email address

UserPsnInfo

Object

Name	Type	Description
PsnAccountId	string	PlayStation ™️ Network account ID
PsnOnlineId	string	PlayStation ™️ Network online ID

UserServerCustomIdInfo

Object

Name	Type	Description
CustomId	string	Custom ID

UserSettings

Object

Name	Type	Description
GatherDeviceInfo	boolean	Boolean for whether this player is eligible for gathering device info.
GatherFocusInfo	boolean	Boolean for whether this player should report OnFocus play-time tracking.
NeedsAttribution	boolean	Boolean for whether this player is eligible for ad tracking.

UserSteamInfo

Object

Name	Type	Description
SteamActivationStatus	TitleActivationStatus	what stage of game ownership the user is listed as being in, from Steam
SteamCountry	string	the country in which the player resides, from Steam data
SteamCurrency	Currency	currency type set in the user Steam account
SteamId	string	Steam identifier
SteamName	string	Steam display name

UserTitleInfo

Object

Name	Type	Description
AvatarUrl	string	URL to the player's avatar.
Created	string	timestamp indicating when the user was first associated with this game (this can differ significantly from when the user first registered with PlayFab)
DisplayName	string	name of the user, as it is displayed in-game
FirstLogin	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)
LastLogin	string	timestamp for the last user login for this title
Origination	UserOrigination	source by which the user first joined the game, if known
TitlePlayerAccount	EntityKey	Title player account entity for this user
isBanned	boolean	boolean indicating whether or not the user is currently banned for a title

UserTwitchInfo

Object

Name	Type	Description
TwitchId	string	Twitch ID
TwitchUserName	string	Twitch Username

UserXboxInfo

Object

Name	Type	Description
XboxUserId	string	XBox user ID
XboxUserSandbox	string	XBox user sandbox

ValueToDateModel

Object

Name	Type	Description
Currency	string	ISO 4217 code of the currency used in the purchases
TotalValue	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')
TotalValueAsDecimal	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'.

Variable

Object

Name	Type	Description
Name	string	Name of the variable.
Value	string	Value of the variable.

VirtualCurrencyRechargeTime

Object

Name	Type	Description
RechargeMax	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.
RechargeTime	string	Server timestamp in UTC indicating the next time the virtual currency will be incremented.
SecondsToRecharge	number	Time remaining (in seconds) before the next recharge increment of the virtual currency.

Error Codes

Name	Code
EncryptedRequestNotAllowed	1301
EncryptionKeyMissing	1290
EvaluationModePlayerCountExceeded	1490
InvalidSignature	1273
InvalidSignatureTime	1324
PlayerSecretAlreadyConfigured	1294
PlayerSecretNotConfigured	1323
RequestViewConstraintParamsNotAllowed	1303
SignedRequestNotAllowed	1302