Account Management - Get User Account Info

Service:

Admin

API Version:

250314

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

POST https://titleId.playfabapi.com/Admin/GetUserAccountInfo

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Type	Description
Email	string	User email address attached to their account
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.
TitleDisplayName	string	Title specific username to match against existing user accounts
Username	string	PlayFab username for the account (3-20 characters)

Responses

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

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
Currency
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
LookupUserAccountInfoRequest	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.
LookupUserAccountInfoResult
TitleActivationStatus
UserAccountInfo
UserAndroidDeviceInfo
UserAppleIdInfo
UserCustomIdInfo
UserFacebookInfo
UserFacebookInstantGamesIdInfo
UserGameCenterInfo
UserGoogleInfo
UserGooglePlayGamesInfo
UserIosDeviceInfo
UserKongregateInfo
UserNintendoSwitchAccountIdInfo
UserNintendoSwitchDeviceIdInfo
UserOpenIdInfo
UserOrigination
UserPrivateAccountInfo
UserPsnInfo
UserServerCustomIdInfo
UserSteamInfo
UserTitleInfo
UserTwitchInfo
UserXboxInfo

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

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

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

LookupUserAccountInfoRequest

Object

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.

Name	Type	Description
Email	string	User email address attached to their account
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.
TitleDisplayName	string	Title specific username to match against existing user accounts
Username	string	PlayFab username for the account (3-20 characters)

LookupUserAccountInfoResult

Object

Name	Type	Description
UserInfo	UserAccountInfo	User info for the user matching the request

TitleActivationStatus

Enumeration

Value	Description
ActivatedSteam
ActivatedTitleKey
None
PendingSteam
RevokedSteam

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

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
BattleNet
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

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

Error Codes

Name	Code
TitleNotActivated	1042