Account Management - Get Title Players From Xbox Live IDs

Service:

Profiles

API Version:

240524

Retrieves the title player accounts associated with the given XUIDs.

POST https://titleId.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
Sandbox	True	string	Xbox Sandbox the players had on their Xbox tokens.
XboxLiveIds	True	string[]	List of Xbox Live XUIDs
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
TitleId		string	Optional ID of title to get players from, required if calling using a master_player_account.

Responses

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

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityLineage
GetTitlePlayersFromProviderIDsResponse
GetTitlePlayersFromXboxLiveIDsRequest	Given a collection of Xbox IDs (XUIDs), returns all title player accounts.

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

EntityLineage

Name	Type	Description
CharacterId	string	The Character Id of the associated entity.
GroupId	string	The Group Id of the associated entity.
MasterPlayerAccountId	string	The Master Player Account Id of the associated entity.
NamespaceId	string	The Namespace Id of the associated entity.
TitleId	string	The Title Id of the associated entity.
TitlePlayerAccountId	string	The Title Player Account Id of the associated entity.

GetTitlePlayersFromProviderIDsResponse

Name	Type	Description
TitlePlayerAccounts	EntityLineage	Dictionary of provider identifiers mapped to title_player_account lineage. Missing lineage indicates the player either doesn't exist or doesn't play the requested title.

GetTitlePlayersFromXboxLiveIDsRequest

Given a collection of Xbox IDs (XUIDs), returns all title player accounts.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Sandbox	string	Xbox Sandbox the players had on their Xbox tokens.
TitleId	string	Optional ID of title to get players from, required if calling using a master_player_account.
XboxLiveIds	string[]	List of Xbox Live XUIDs