Account Management - Link Facebook Account
Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
POST https://titleId.playfabapi.com/Client/LinkFacebookAccount
Name | Required | Type | Description |
---|---|---|---|
X-Authorization | True |
string |
This API requires a client session ticket, available from any Client Login function. |
Name | Required | Type | Description |
---|---|---|---|
AccessToken | True |
string |
Unique identifier from Facebook for the user. |
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 the account, unlink the other user and re-link. |
Name | Type | Description |
---|---|---|
200 OK | ||
400 Bad Request |
This is the outer wrapper for all responses with errors |
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Name | Description |
---|---|
Api |
The basic wrapper around every failed API response |
Link |
Facebook sign-in is accomplished using the Facebook User Access Token. More information on the Token can be found in the Facebook developer documentation (https://developers.facebook.com/docs/facebook-login/access-tokens/). In Unity, for example, the Token is available as AccessToken in the Facebook SDK ScriptableObject FB. Note that titles should never re-use the same Facebook applications between PlayFab Title IDs, as Facebook provides unique user IDs per application and doing so can result in issues with the Facebook ID for the user in their PlayFab account information. If you must re-use an application in a new PlayFab Title ID, please be sure to first unlink all accounts from Facebook, or delete all users in the first Title ID. |
Link |
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 |
Facebook sign-in is accomplished using the Facebook User Access Token. More information on the Token can be found in the Facebook developer documentation (https://developers.facebook.com/docs/facebook-login/access-tokens/). In Unity, for example, the Token is available as AccessToken in the Facebook SDK ScriptableObject FB. Note that titles should never re-use the same Facebook applications between PlayFab Title IDs, as Facebook provides unique user IDs per application and doing so can result in issues with the Facebook ID for the user in their PlayFab account information. If you must re-use an application in a new PlayFab Title ID, please be sure to first unlink all accounts from Facebook, or delete all users in the first Title ID.
Name | Type | Description |
---|---|---|
AccessToken |
string |
Unique identifier from Facebook for the user. |
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 the account, unlink the other user and re-link. |
Name | Code |
---|---|
AccountAlreadyLinked | 1011 |
AccountNotFound | 1001 |
FacebookAPIError | 1143 |
InvalidFacebookToken | 1013 |
LinkedAccountAlreadyClaimed | 1012 |