Documentation

AuthUser

Validates a user with the PlayFab service

Request Details

This API allows the external match-making service to confirm that the user has a valid Session Ticket for the title, in order to securely enable match-making. The client passes the user's Session Ticket to the external match-making service, which then passes the Session Ticket in as the AuthorizationTicket in this call.

AuthUserRequest
Request Properties
AuthorizationTicket (required) String

Session Ticket provided by the client.

POST https://{{TitleID}}.playfabapi.com/Matchmaker/AuthUser
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "AuthorizationTicket": "9F856B4A071A9A5D-0-0-AD0-8D165320C16429B-72087E2356D29870.9D0410B3E78D8A5F"
}
        

Response Details

AuthUserResponse
Result Properties
Authorized (required) Boolean

Boolean indicating if the user has been authorized to use the external match-making service.

PlayFabId String

PlayFab unique identifier of the account that has been authorized.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Authorized": true,
    "PlayFabId": "23990802934"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
InvalidParams 1000