Account Management - Link PSN Id
Links the PlayStation ™️ Network account associated with the provided user id to the user's PlayFab account
POST https://titleId.playfabapi.com/Server/LinkPSNIdRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| PSNUserId | True |
string |
Id of the PlayStation ™️ Network user. Also known as the PSN Account Id. |
| PlayFabId | True |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
| 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. |
|
| IssuerId |
number |
Id of the PlayStation ™️ Network issuer environment. If null, defaults to production environment. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Link |
|
|
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 |
LinkPSNIdRequest
| Name | Type | Description |
|---|---|---|
| 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. |
| IssuerId |
number |
Id of the PlayStation ™️ Network issuer environment. If null, defaults to production environment. |
| PSNUserId |
string |
Id of the PlayStation ™️ Network user. Also known as the PSN Account Id. |
| PlayFabId |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
LinkPSNIdResponse
Error Codes
| Name | Code |
|---|---|
| AccountAlreadyLinked | 1011 |
| AccountNotFound | 1001 |
| InvalidNamespaceMismatch | 1561 |
| InvalidPSNAuthCode | 1092 |
| InvalidPSNIssuerId | 1151 |
| LinkedAccountAlreadyClaimed | 1012 |
| PSNInaccessible | 1152 |
"PlayStation" is a registered trademark or trademark of Sony Interactive Entertainment Inc.