Documentation

LinkOpenIdConnect

Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an Open ID Connect provider and the OpenId Connect JWT from that provider.

Request Details

LinkOpenIdConnectRequest
Request Properties
ConnectionId (required) String

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

ForceLink Boolean

If another user is already linked to a specific OpenId Connect user, unlink the other user and re-link.

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. Used to validate the request and find the user ID (OpenID Connect subject) to link with.

POST https://{{TitleID}}.playfabapi.com/Client/LinkOpenIdConnect
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "ConnectionId": "exampleprovider",
  "IdToken": "eyJraWQi..."
}
        

Response Details

EmptyResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SessionTicket

Possible Error Codes

Name Code
InvalidIdentityProviderId 1263
LinkedIdentifierAlreadyClaimed 1184