Documentation

LinkSteamAccount

Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account

Request Details

Steam authentication is accomplished with the Steam Session Ticket. More information on the Ticket can be found in the Steamworks SDK, here: https://partner.steamgames.com/documentation/auth (requires sign-in). NOTE: For Steam authentication to work, the title must be configured with the Steam Application ID and Publisher Key in the PlayFab Game Manager (under Properties). Information on creating a Publisher Key (referred to as the Secret Key in PlayFab) for your title can be found here: https://partner.steamgames.com/documentation/webapi#publisherkey.

LinkSteamAccountRequest
Request Properties
ForceLink Boolean

If another user is already linked to the account, unlink the other user and re-link.

SteamTicket (required) String

Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte 0x08 should become "08").

POST https://{{TitleID}}.playfabapi.com/Client/LinkSteamAccount
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "SteamTicket": "steamTicketID"
}
        

Response Details

LinkSteamAccountResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SessionTicket

Possible Error Codes

Name Code
AccountAlreadyLinked 1011
InvalidSteamTicket 1010
LinkedAccountAlreadyClaimed 1012
SteamNotEnabledForTitle 1258