Account Management - Get PlayFab IDs From Nintendo Switch Device Ids
Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
POST https://titleId.playfabapi.com/Server/GetPlayFabIDsFromNintendoSwitchDeviceIds
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 |
---|---|---|---|
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 |
For Nintendo Switch Device 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
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
Name | Description |
---|---|
Api |
The basic wrapper around every failed API response |
Get |
|
Get |
For Nintendo Switch Device identifiers which have not been linked to PlayFab accounts, null will be returned. |
Nintendo |
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 Device identifiers which have not been linked to PlayFab accounts, null will be returned.
Name | Type | Description |
---|---|---|
Data |
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. |