Account Management - Get PlayFab IDs From Game Center IDs

Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier).

POST https://titleId.playfabapi.com/Client/GetPlayFabIDsFromGameCenterIDs

Request Header

Name Required Type Description
SessionTicket True
  • string

This API requires a client session ticket, available from any Client Login function.

Request Body

Name Required Type Description
GameCenterIDs True
  • string[]

Array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers.

Responses

Name Type Description
200 OK

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

400 Bad Request

This is the outer wrapper for all responses with errors

Security

SessionTicket

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

GameCenterPlayFabIdPair
GetPlayFabIDsFromGameCenterIDsRequest
GetPlayFabIDsFromGameCenterIDsResult

For Game Center 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

GameCenterPlayFabIdPair

Name Type Description
GameCenterId
  • string

Unique Game Center identifier for a user.

PlayFabId
  • string

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

GetPlayFabIDsFromGameCenterIDsRequest

Name Type Description
GameCenterIDs
  • string[]

Array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers.

GetPlayFabIDsFromGameCenterIDsResult

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

Name Type Description
Data

Mapping of Game Center identifiers to PlayFab identifiers.