Account Management - Link Nintendo Service Account

Service:

Server

API Version:

250704

Links the Nintendo account associated with the token to the user's PlayFab account

POST https://titleId.playfabapi.com/Server/LinkNintendoServiceAccount

Request 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
IdentityToken	True	string	The JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo Switch subject) to link with.
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 a specific Nintendo Switch account, unlink the other user and re-link.

Responses

Name	Type	Description
200 OK	EmptyResult
400 Bad Request	ApiErrorWrapper	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
ApiErrorWrapper	The basic wrapper around every failed API response
EmptyResult
LinkNintendoServiceAccountRequest

ApiErrorWrapper

Object

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

Object

LinkNintendoServiceAccountRequest

Object

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 a specific Nintendo Switch account, unlink the other user and re-link.
IdentityToken	string	The JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo Switch subject) to link with.
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.

Error Codes

Name	Code
InvalidIdentityProviderId	1263
LinkedIdentifierAlreadyClaimed	1184
NintendoSwitchNotEnabledForTitle	1506