Account Management - Get PlayFab IDs From Nintendo Switch Device Ids

Service:

Client

API Version:

240401

Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.

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

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
NintendoSwitchDeviceIds	True	string[]	Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

Responses

Name	Type	Description
200 OK	GetPlayFabIDsFromNintendoSwitchDeviceIdsResult	For Nintendo Switch 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
GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest
GetPlayFabIDsFromNintendoSwitchDeviceIdsResult	For Nintendo Switch identifiers which have not been linked to PlayFab accounts, null will be returned.
NintendoSwitchPlayFabIdPair

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

GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest

Name	Type	Description
NintendoSwitchDeviceIds	string[]	Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

GetPlayFabIDsFromNintendoSwitchDeviceIdsResult

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

Name	Type	Description
Data	NintendoSwitchPlayFabIdPair[]	Mapping of Nintendo Switch Device identifiers to PlayFab identifiers.

NintendoSwitchPlayFabIdPair

Name	Type	Description
NintendoSwitchDeviceId	string	Unique Nintendo Switch Device identifier for a user.
PlayFabId	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Device identifier.