Account Management - Link Steam Account

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

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

Request Header

Name Required Type Description
SessionTicket True
  • string

This API requires a client session ticket, available from any Client Login function.

Request Body

Name Required Type Description
ForceLink
  • boolean

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

SteamTicket True
  • 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").

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SessionTicket

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

LinkSteamAccountRequest

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.

LinkSteamAccountResult

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

LinkSteamAccountRequest

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.

Name Type Description
ForceLink
  • boolean

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

SteamTicket
  • 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").

LinkSteamAccountResult

Error Codes

Name Code
AccountAlreadyLinked 1011
InvalidSteamTicket 1010
LinkedAccountAlreadyClaimed 1012
SteamNotEnabledForTitle 1258