Account Management - Get PlayFab IDs From PSN Account IDs

  • Reference
Service:
Client
API Version:
240412

Retrieves the unique PlayFab identifiers for the given set of PlayStation ™️ Network identifiers.

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

Request Header

Name Required Type Description
X-Authorization True

string

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

Request Body

Name Required Type Description
PSNAccountIDs True

string[]

Array of unique PlayStation ™️ Network identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.
IssuerId

number

Id of the PlayStation ™️ Network issuer environment. If null, defaults to production environment.

Responses

Name Type Description
200 OK

GetPlayFabIDsFromPSNAccountIDsResult

For PlayStation ™️ Network 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-Authorization

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
GetPlayFabIDsFromPSNAccountIDsRequest
GetPlayFabIDsFromPSNAccountIDsResult

For PlayStation ™️ Network identifiers which have not been linked to PlayFab accounts, null will be returned.
PSNAccountPlayFabIdPair

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

GetPlayFabIDsFromPSNAccountIDsRequest

Name Type Description
IssuerId

number

Id of the PlayStation ™️ Network issuer environment. If null, defaults to production environment.
PSNAccountIDs

string[]

Array of unique PlayStation ™️ Network identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

GetPlayFabIDsFromPSNAccountIDsResult

For PlayStation ™️ Network identifiers which have not been linked to PlayFab accounts, null will be returned.

Name Type Description
Data

PSNAccountPlayFabIdPair[]

Mapping of PlayStation ™️ Network identifiers to PlayFab identifiers.

PSNAccountPlayFabIdPair

Name Type Description
PSNAccountId

string

Unique PlayStation ™️ Network identifier for a user.
PlayFabId

string

Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the PlayStation ™️ Network identifier.

Error Codes

Name Code
InvalidPSNAuthCode 1092

"PlayStation" is a registered trademark or trademark of Sony Interactive Entertainment Inc.