Documentation

AuthenticateSessionTicket

Validated a client's session ticket, and if successful, returns details for that user

Request Details

Note that data returned may be Personally Identifying Information (PII), such as email address, and so care should be taken in how this data is stored and managed. Since this call will always return the relevant information for users who have accessed the title, the recommendation is to not store this data locally.

AuthenticateSessionTicketRequest
Request Properties
SessionTicket (required) String

Session ticket as issued by a PlayFab client login API.

POST https://{{TitleID}}.playfabapi.com/Server/AuthenticateSessionTicket
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "SessionTicket": "4D2----8D11F4249A80000-7C64AB0A9F1D8D1A.CD803BF233CE76CC"
}
        

Response Details

AuthenticateSessionTicketResult
Result Properties
UserInfo UserAccountInfo

Account info for the user whose session ticket was supplied.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "UserInfo": {
      "PlayFabId": "10931252888739651331",
      "Created": "0001-01-01T00:00:00Z",
      "Username": "accountname"
    }
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
InvalidSessionTicket 1100