Documentation

LoginWithOpenIdConnect

Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.

Request Details

LoginWithOpenIdConnectRequest
Request Properties
ConnectionId (required) String

A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters.

CreateAccount Boolean

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

EncryptedRequest String

Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).

IdToken (required) String

The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the identity provider's response.

InfoRequestParameters GetPlayerCombinedInfoRequestParams

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

PlayerSecret String

Player secret that is used to verify API request signatures (Enterprise Only).

TitleId (required) String

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

POST https://{{TitleID}}.playfabapi.com/Client/LoginWithOpenIdConnect
    Content-Type: application/json
{
  "ConnectionId": "exampleprovider",
  "IdToken": "eyJraWQi..."
}
        

Response Details

LoginResult
Result Properties
EntityToken EntityTokenResponse

If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and returned.

InfoResultPayload GetPlayerCombinedInfoResultPayload

Results for requested info.

LastLoginTime DateTime

The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue

NewlyCreated (required) Boolean

True if the account was newly created on this login.

PlayFabId String

Player's unique PlayFabId.

SessionTicket String

Unique token authorizing the user and game at the server level, for the current session.

SettingsForUser UserSettings

Settings specific to this user.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "PlayFabId": "50DF92E291CCD4C3",
    "NewlyCreated": false
  }
}

Authentication

None

Possible Error Codes

Name Code
AccountNotFound 1001
InvalidIdentityProviderId 1263
InvalidSignature 1273
InvalidSignatureTime 1324
InvalidTitleId 1004
PlayerSecretAlreadyConfigured 1294
PlayerSecretNotConfigured 1323
RequestViewConstraintParamsNotAllowed 1303