Account Management - Link OpenId Connect
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.
POST https://titleId.playfabapi.com/Client/LinkOpenIdConnectRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Authorization | True |
string |
This API requires a client session ticket, available from any Client Login function. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| ConnectionId | True |
string |
A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters. |
| IdToken | True |
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. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| ForceLink |
boolean |
If another user is already linked to a specific OpenId Connect user, unlink the other user and re-link. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-Authorization
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Empty |
|
|
Link |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
EmptyResult
LinkOpenIdConnectRequest
| Name | Type | Description |
|---|---|---|
| ConnectionId |
string |
A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| ForceLink |
boolean |
If another user is already linked to a specific OpenId Connect user, unlink the other user and re-link. |
| IdToken |
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. |
Error Codes
| Name | Code |
|---|---|
| InvalidIdentityProviderId | 1263 |
| LinkedIdentifierAlreadyClaimed | 1184 |