Account Management - Get PlayFab IDs From Generic IDs

Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.

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

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
GenericIDs True

GenericServiceId[]

Array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a maximum of 10 in a single request.

Responses

Name Type Description
200 OK

GetPlayFabIDsFromGenericIDsResult

For generic service 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

GenericPlayFabIdPair
GenericServiceId
GetPlayFabIDsFromGenericIDsRequest
GetPlayFabIDsFromGenericIDsResult

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

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

GenericPlayFabIdPair

Name Type Description
GenericId

GenericServiceId

Unique generic service identifier for a user.

PlayFabId

string

Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the given generic identifier.

GenericServiceId

Name Type Description
ServiceName

string

Name of the service for which the player has a unique identifier.

UserId

string

Unique identifier of the player in that service.

GetPlayFabIDsFromGenericIDsRequest

Name Type Description
GenericIDs

GenericServiceId[]

Array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a maximum of 10 in a single request.

GetPlayFabIDsFromGenericIDsResult

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

Name Type Description
Data

GenericPlayFabIdPair[]

Mapping of generic service identifiers to PlayFab identifiers.