Allows an Nintendo Network Service Account (NSA) to be used as an authentication mechanism.

Once authenticated the platform can determine the current players details from the NSA and store them within GameSparks.

GameSparks will determine the player's friends and whether any of them are currently registered with the game.

If the NSA is already linked to a player, the current session will switch to the linked player.

If the current player has previously created an account using either DeviceAuthentictionRequest or RegistrationRequest AND the NSA is not already registered with the game, the NSA will be linked to the current player.

If the current player has not authenticated and the NSA is not known, a new player will be created using the NSA details and the session will be authenticated against the new player.

If the NSA is already known, the session will switch to being the previously created user.

View interactive version here

Request Parameters

Parameter Required Type Description
accountPerLoginId No boolean Whether to create one GameSparks player per console login ID
displayName No string The display name of the current player from NX. This will be used as the displayName of the gamesparks player if created (or syncDisplayname is true)
doNotCreateNewPlayer No boolean Indicates whether the server should return an error if a new player would have been registered, rather than creating the player. Defaults to false.
doNotLinkToCurrentPlayer No boolean Indicates that the server should not try to link the external profile with the current player. If false, links the external profile to the currently signed in player. If true, creates a new player and links the external profile to them. Defaults to false.
errorOnSwitch No boolean Indicates whether the server should return an error if an account switch would have occurred, rather than switching automatically. Defaults to false.
nsaIdToken No string The NSA ID token obtained from Nintendo
segments No JSON An optional segment configuration for this request.
switchIfPossible No boolean Indicates that the server should switch to the supplied profile if it isalready associated to a player. Defaults to false.
syncDisplayName No boolean Indicates that the associated players displayName should be kept in syn with this profile when it's updated by the external provider.

Response Parameters

A response containing the auth token

Parameter Type Description
authToken string 44b297a8-162a-4220-8c14-dad9a1946ad2
displayName string The player's display name
newPlayer boolean Indicates whether the player was created as part of this request
scriptData ScriptData A JSON Map of any data added either to the Request or the Response by your Cloud Code
switchSummary Player A summary of the player that would be switched to. Only returned as part of an error response for a request where automatic switching is disabled.
userId string The player's id

Nested types


A collection of arbitrary data that can be added to a message via a Cloud Code script.

Parameter Type Description
myKey string An arbitrary data key
myValue JSON An arbitrary data value.


A nested object that represents a player.

Parameter Type Description
achievements string[] The achievements of the Player
displayName string The display name of the Player
externalIds JSON The external Id's of the Player
id string The Id of the Player
online boolean The online status of the Player
scriptData JSON The script data of the Player
virtualGoods string[] The virtual goods of the Player

Error Codes

Key Value Description
NX NOT_CONFIGURED The game does not have the NX integration details configured.
nsaIdToken NOTAUTHENTICATED The system was unable to authenticate the NSA ID token
nsaIdToken REQUIRED Parameter nsaIdToken is required but was not provided
accessToken ACCOUNT_ALREADY_LINKED The current user has an NSA profile and it's not the profile they have just tried to log in with
displayName REQUIRED Parameter displayName is required but not provided
authentication COPPA restricted Social authentications are not allowed on COPPA compliant credentials due to social accounts containing personally identifiable information

Code Samples


    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    new NXConnectRequest()
        .Send((response) => {
        string authToken = response.AuthToken; 
        string displayName = response.DisplayName; 
        bool? newPlayer = response.NewPlayer; 
        GSData scriptData = response.ScriptData; 
        var switchSummary = response.SwitchSummary; 
        string userId = response.UserId; 

ActionScript 3

    import com.gamesparks.*;
    import com.gamesparks.api.requests.*;
    import com.gamesparks.api.responses.*;
    import com.gamesparks.api.types.*;

        .send(function(response:com.gamesparks.api.responses.AuthenticationResponse):void {
        var authToken:String = response.getAuthToken(); 
        var displayName:String = response.getDisplayName(); 
        var newPlayer:Boolean = response.getNewPlayer(); 
        var scriptData:ScriptData = response.getScriptData(); 
        var switchSummary:Player = response.getSwitchSummary(); 
        var userId:String = response.getUserId(); 


    #import "GS.h"
    #import "GSAPI.h"
    GSNXConnectRequest* request = [[GSNXConnectRequest alloc] init];
    [request setAccountPerLoginId:accountPerLoginId;
    [request setDisplayName:displayName;
    [request setDoNotCreateNewPlayer:doNotCreateNewPlayer;
    [request setDoNotLinkToCurrentPlayer:doNotLinkToCurrentPlayer;
    [request setErrorOnSwitch:errorOnSwitch;
    [request setNsaIdToken:nsaIdToken;
    [request setSegments:segments;
    [request setSwitchIfPossible:switchIfPossible;
    [request setSyncDisplayName:syncDisplayName;
    [request setCallback:^ (GSAuthenticationResponse* response) {
    NSString* authToken = [response getAuthToken]; 
    NSString* displayName = [response getDisplayName]; 
    BOOL newPlayer = [response getNewPlayer]; 
    NSDictionary* scriptData = [response getScriptData]; 
    GSPlayer* switchSummary = [response getSwitchSummary]; 
    NSString* userId = [response getUserId]; 
    [gs send:request];


    #include <GameSparks/generated/GSRequests.h>
    using namespace GameSparks::Core;
    using namespace GameSparks::Api::Responses;
    using namespace GameSparks::Api::Requests;

    void NXConnectRequest_Response(GS& gsInstance, const AuthenticationResponse& response) {
    gsstl::string authToken = response.getAuthToken(); 
    gsstl::string displayName = response.getDisplayName(); 
    Optional::t_BoolOptional newPlayer = response.getNewPlayer(); 
    GSData scriptData = response.getScriptData(); 
    Types::Player* switchSummary = response.getSwitchSummary(); 
    gsstl::string userId = response.getUserId(); 

    NXConnectRequest request(gsInstance);


import com.gamesparks.sdk.api.autogen.GSRequestBuilder.NXConnectRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.AuthenticationResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

    .send(new GSEventListener<AuthenticationResponse>() {
        public void onEvent(AuthenticationResponse response) {
            String authToken = response.getAuthToken(); 
            String displayName = response.getDisplayName(); 
            Boolean newPlayer = response.getNewPlayer(); 
            GSData scriptData = response.getScriptData(); 
            Player switchSummary = response.getSwitchSummary(); 
            String userId = response.getUserId(); 

Cloud Code

    var request = new SparkRequests.NXConnectRequest();
    request.accountPerLoginId = ...;
    request.displayName = ...;
    request.doNotCreateNewPlayer = ...;
    request.doNotLinkToCurrentPlayer = ...;
    request.errorOnSwitch = ...;
    request.nsaIdToken = ...;
    request.segments = ...;
    request.switchIfPossible = ...;
    request.syncDisplayName = ...;
    var response = request.Send();

var authToken = response.authToken; 
var displayName = response.displayName; 
var newPlayer = response.newPlayer; 
var scriptData = response.scriptData; 
var switchSummary = response.switchSummary; 
var userId = response.userId; 
Did this page help you? Please enter your feedback below. For questions about using this part of the platform, please contact support here