Account Management - Get PlayFab IDs From Xbox Live IDs

Service:

Server

API Version:

240412

Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.

POST https://titleId.playfabapi.com/Server/GetPlayFabIDsFromXboxLiveIDs

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	Required	Type	Description
XboxLiveAccountIDs	True	string[]	Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.
Sandbox		string	The ID of Xbox Live sandbox.

Responses

Name	Type	Description
200 OK	GetPlayFabIDsFromXboxLiveIDsResult	For XboxLive identifiers which have not been linked to PlayFab accounts, null will be returned.
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
GetPlayFabIDsFromXboxLiveIDsRequest
GetPlayFabIDsFromXboxLiveIDsResult	For XboxLive identifiers which have not been linked to PlayFab accounts, null will be returned.
XboxLiveAccountPlayFabIdPair

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

GetPlayFabIDsFromXboxLiveIDsRequest

Name	Type	Description
Sandbox	string	The ID of Xbox Live sandbox.
XboxLiveAccountIDs	string[]	Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

GetPlayFabIDsFromXboxLiveIDsResult

For XboxLive identifiers which have not been linked to PlayFab accounts, null will be returned.

Name	Type	Description
Data	XboxLiveAccountPlayFabIdPair[]	Mapping of Xbox Live identifiers to PlayFab identifiers.

XboxLiveAccountPlayFabIdPair

Name	Type	Description
PlayFabId	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier.
XboxLiveAccountId	string	Unique Xbox Live identifier for a user.