Login With Steam

Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Error codes

This operation may return the following PlayFab errors:

Error	Code
EncryptionKeyMissing	1290
EvaluationModePlayerCountExceeded	1490
InvalidSteamTicket	1010
PlayerSecretAlreadyConfigured	1294
PlayerSecretNotConfigured	1323
RequestViewConstraintParamsNotAllowed	1303
SteamNotEnabledForTitle	1258
SteamUserNotFound	1513

POST

Client

LoginWithSteam

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/LoginWithSteam \
  --header 'Content-Type: application/json' \
  --data '
{
  "SteamTicket": "steamTicketID",
  "CreateAccount": false,
  "TicketIsServiceSpecific": true,
  "TitleId": "144"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/LoginWithSteam"

payload = {
    "SteamTicket": "steamTicketID",
    "CreateAccount": False,
    "TicketIsServiceSpecific": True,
    "TitleId": "144"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    SteamTicket: 'steamTicketID',
    CreateAccount: false,
    TicketIsServiceSpecific: true,
    TitleId: '144'
  })
};

fetch('https://{titleId}.playfabapi.com/Client/LoginWithSteam', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/LoginWithSteam",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'SteamTicket' => 'steamTicketID',
    'CreateAccount' => false,
    'TicketIsServiceSpecific' => true,
    'TitleId' => '144'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/LoginWithSteam"

	payload := strings.NewReader("{\n  \"SteamTicket\": \"steamTicketID\",\n  \"CreateAccount\": false,\n  \"TicketIsServiceSpecific\": true,\n  \"TitleId\": \"144\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/LoginWithSteam")
  .header("Content-Type", "application/json")
  .body("{\n  \"SteamTicket\": \"steamTicketID\",\n  \"CreateAccount\": false,\n  \"TicketIsServiceSpecific\": true,\n  \"TitleId\": \"144\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/LoginWithSteam")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"SteamTicket\": \"steamTicketID\",\n  \"CreateAccount\": false,\n  \"TicketIsServiceSpecific\": true,\n  \"TitleId\": \"144\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "PlayFabId": "50DF92E291CCD4C3"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Body

application/json

Steam sign-in 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. NOTE: For Steam authentication to work, the title must be configured with the Steam Application ID and Web API Key in the PlayFab Game Manager (under Steam in the Add-ons Marketplace). You can obtain a Web API Key from the Permissions page of any Group associated with your App ID in the Steamworks site. If this is the first time a user has signed in with the Steam account and CreateAccount is set to true, a new PlayFab account will be created and linked to the provided account's Steam ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Steam account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.

TitleId

string

required

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

CreateAccount

boolean

Automatically create a PlayFab account if one is not currently linked to this ID.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EncryptedRequest

string

Base64 encoded body that is encrypted with the Title's public RSA key.

InfoRequestParameters

object

Flags for which pieces of info to return for the user.

Show child attributes

Example:

{
  "GetUserAccountInfo": true,
  "GetUserVirtualCurrency": true,
  "GetUserData": true,
  "UserDataKeys": ["preferences", "progress"]
}

PlayerSecret

string

Player secret that is used to verify API request signatures.

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

TicketIsServiceSpecific

boolean

True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using "AzurePlayFab" as the identity string. False if the ticket was generated with ISteamUser::GetAuthSessionTicket().

Response

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Example:

{
  "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
  "PlayFabId": "50DF92E291CCD4C3"
}

Last modified on October 2, 2026

⌘I

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/LoginWithSteam \
  --header 'Content-Type: application/json' \
  --data '
{
  "SteamTicket": "steamTicketID",
  "CreateAccount": false,
  "TicketIsServiceSpecific": true,
  "TitleId": "144"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/LoginWithSteam"

payload = {
    "SteamTicket": "steamTicketID",
    "CreateAccount": False,
    "TicketIsServiceSpecific": True,
    "TitleId": "144"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    SteamTicket: 'steamTicketID',
    CreateAccount: false,
    TicketIsServiceSpecific: true,
    TitleId: '144'
  })
};

fetch('https://{titleId}.playfabapi.com/Client/LoginWithSteam', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/LoginWithSteam",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'SteamTicket' => 'steamTicketID',
    'CreateAccount' => false,
    'TicketIsServiceSpecific' => true,
    'TitleId' => '144'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/LoginWithSteam"

	payload := strings.NewReader("{\n  \"SteamTicket\": \"steamTicketID\",\n  \"CreateAccount\": false,\n  \"TicketIsServiceSpecific\": true,\n  \"TitleId\": \"144\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/LoginWithSteam")
  .header("Content-Type", "application/json")
  .body("{\n  \"SteamTicket\": \"steamTicketID\",\n  \"CreateAccount\": false,\n  \"TicketIsServiceSpecific\": true,\n  \"TitleId\": \"144\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/LoginWithSteam")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"SteamTicket\": \"steamTicketID\",\n  \"CreateAccount\": false,\n  \"TicketIsServiceSpecific\": true,\n  \"TitleId\": \"144\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "PlayFabId": "50DF92E291CCD4C3"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Login With Steam

Error codes

Body

Response