Account Management - Get PlayFab IDs From Steam IDs
Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
POST https://titleId.playfabapi.com/Client/GetPlayFabIDsFromSteamIDsRequest 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 | Type | Description |
|---|---|---|
| SteamStringIDs |
string[] |
Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
For Steam 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-Authorization
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Get |
|
|
Get |
For Steam identifiers which have not been linked to PlayFab accounts, null will be returned. |
|
Steam |
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 |
GetPlayFabIDsFromSteamIDsRequest
| Name | Type | Description |
|---|---|---|
| SteamStringIDs |
string[] |
Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length. |
GetPlayFabIDsFromSteamIDsResult
For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.
| Name | Type | Description |
|---|---|---|
| Data |
Mapping of Steam identifiers to PlayFab identifiers. |
SteamPlayFabIdPair
| Name | Type | Description |
|---|---|---|
| PlayFabId |
string |
Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. |
| SteamStringId |
string |
Unique Steam identifier for a user. |