Account Management - Get User Account Info

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

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

Name Type Description
AED

string

AFN

string

ALL

string

AMD

string

ANG

string

AOA

string

ARS

string

AUD

string

AWG

string

AZN

string

BAM

string

BBD

string

BDT

string

BGN

string

BHD

string

BIF

string

BMD

string

BND

string

BOB

string

BRL

string

BSD

string

BTN

string

BWP

string

BYR

string

BZD

string

CAD

string

CDF

string

CHF

string

CLP

string

CNY

string

COP

string

CRC

string

CUC

string

CUP

string

CVE

string

CZK

string

DJF

string

DKK

string

DOP

string

DZD

string

EGP

string

ERN

string

ETB

string

EUR

string

FJD

string

FKP

string

GBP

string

GEL

string

GGP

string

GHS

string

GIP

string

GMD

string

GNF

string

GTQ

string

GYD

string

HKD

string

HNL

string

HRK

string

HTG

string

HUF

string

IDR

string

ILS

string

IMP

string

INR

string

IQD

string

IRR

string

ISK

string

JEP

string

JMD

string

JOD

string

JPY

string

KES

string

KGS

string

KHR

string

KMF

string

KPW

string

KRW

string

KWD

string

KYD

string

KZT

string

LAK

string

LBP

string

LKR

string

LRD

string

LSL

string

LYD

string

MAD

string

MDL

string

MGA

string

MKD

string

MMK

string

MNT

string

MOP

string

MRO

string

MUR

string

MVR

string

MWK

string

MXN

string

MYR

string

MZN

string

NAD

string

NGN

string

NIO

string

NOK

string

NPR

string

NZD

string

OMR

string

PAB

string

PEN

string

PGK

string

PHP

string

PKR

string

PLN

string

PYG

string

QAR

string

RON

string

RSD

string

RUB

string

RWF

string

SAR

string

SBD

string

SCR

string

SDG

string

SEK

string

SGD

string

SHP

string

SLL

string

SOS

string

SPL

string

SRD

string

STD

string

SVC

string

SYP

string

SZL

string

THB

string

TJS

string

TMT

string

TND

string

TOP

string

TRY

string

TTD

string

TVD

string

TWD

string

TZS

string

UAH

string

UGX

string

USD

string

UYU

string

UZS

string

VEF

string

VND

string

VUV

string

WST

string

XAF

string

XCD

string

XDR

string

XOF

string

XPF

string

YER

string

ZAR

string

ZMW

string

ZWD

string

EntityKey

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

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

Name Type Description
UserInfo

UserAccountInfo

User info for the user matching the request

TitleActivationStatus

Name Type Description
ActivatedSteam

string

ActivatedTitleKey

string

None

string

PendingSteam

string

RevokedSteam

string

UserAccountInfo

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

Name Type Description
AndroidDeviceId

string

Android device ID

UserAppleIdInfo

Name Type Description
AppleSubjectId

string

Apple subject ID

UserCustomIdInfo

Name Type Description
CustomId

string

Custom ID

UserFacebookInfo

Name Type Description
FacebookId

string

Facebook identifier

FullName

string

Facebook full name

UserFacebookInstantGamesIdInfo

Name Type Description
FacebookInstantGamesId

string

Facebook Instant Games ID

UserGameCenterInfo

Name Type Description
GameCenterId

string

Gamecenter identifier

UserGoogleInfo

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

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

Name Type Description
IosDeviceId

string

iOS device ID

UserKongregateInfo

Name Type Description
KongregateId

string

Kongregate ID

KongregateName

string

Kongregate Username

UserNintendoSwitchAccountIdInfo

Name Type Description
NintendoSwitchAccountSubjectId

string

Nintendo Switch account subject ID

UserNintendoSwitchDeviceIdInfo

Name Type Description
NintendoSwitchDeviceId

string

Nintendo Switch Device ID

UserOpenIdInfo

Name Type Description
ConnectionId

string

OpenID Connection ID

Issuer

string

OpenID Issuer

Subject

string

OpenID Subject

UserOrigination

Name Type Description
Amazon

string

Android

string

Apple

string

CustomId

string

Facebook

string

FacebookInstantGamesId

string

GameCenter

string

GamersFirst

string

Google

string

GooglePlayGames

string

IOS

string

Kongregate

string

LoadTest

string

NintendoSwitchAccount

string

NintendoSwitchDeviceId

string

OpenIdConnect

string

Organic

string

PSN

string

Parse

string

ServerCustomId

string

Steam

string

Twitch

string

Unknown

string

XboxLive

string

UserPrivateAccountInfo

Name Type Description
Email

string

user email address

UserPsnInfo

Name Type Description
PsnAccountId

string

PlayStation ™️ Network account ID

PsnOnlineId

string

PlayStation ™️ Network online ID

UserServerCustomIdInfo

Name Type Description
CustomId

string

Custom ID

UserSteamInfo

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

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

Name Type Description
TwitchId

string

Twitch ID

TwitchUserName

string

Twitch Username

UserXboxInfo

Name Type Description
XboxUserId

string

XBox user ID

XboxUserSandbox

string

XBox user sandbox

Error Codes

Name Code
TitleNotActivated 1042