Account Management - Get Server Custom IDs From PlayFab IDs
Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
POST https://titleId.playfabapi.com/Server/GetServerCustomIDsFromPlayFabIDsRequest 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 |
|---|---|---|---|
| PlayFabIDs | True |
string[] |
Array of unique PlayFab player identifiers for which the title needs to get server custom identifiers. Cannot contain more than 25 identifiers. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
For a PlayFab account that isn't associated with a server custom identity, ServerCustomId will be null. |
|
| 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 a PlayFab account that isn't associated with a server custom identity, ServerCustomId will be null. |
|
Server |
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 |
GetServerCustomIDsFromPlayFabIDsRequest
| Name | Type | Description |
|---|---|---|
| PlayFabIDs |
string[] |
Array of unique PlayFab player identifiers for which the title needs to get server custom identifiers. Cannot contain more than 25 identifiers. |
GetServerCustomIDsFromPlayFabIDsResult
For a PlayFab account that isn't associated with a server custom identity, ServerCustomId will be null.
| Name | Type | Description |
|---|---|---|
| Data |
Mapping of server custom player identifiers to PlayFab identifiers. |
ServerCustomIDPlayFabIDPair
| Name | Type | Description |
|---|---|---|
| PlayFabId |
string |
Unique PlayFab identifier. |
| ServerCustomId |
string |
Unique server custom identifier for this player. |