AuthenticateTwitter

Authenticate the user using a Twitter user ID, authentication token, and secret from Twitter.

caution

Make sure you've initialized the brainCloud library before authenticating.

Service	Operation
authenticationV2	AUTHENTICATE

Method Parameters

Parameter	Description
twitterId	String representation of Twitter user ID
token	The authentication token derived via the Twitter APIs
secret	The secret given when attempting to link with Twitter
forceCreate	Should a new profile be created for this user if the account does not exist?

Usage

http://localhost:3000

C#

string twitterId = "userTwitterId";
string token = "userAuthToken";
string secret = "secretFromTwitterApi";
bool forceCreate = true;

SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("[Authenticate Success] {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("[Authenticate Failed] {0}  {1}  {2}", status, code, error));
};
_bc.AuthenticationService.AuthenticateTwitter(
    twitterId, token, secret, forceCreate,
    successCallback, failureCallback);

C++

const char* twitterId = "userTwitterId";
const char* token = "userAuthToken";
const char* secret = "secretFromTwitterApi";
bool forceCreate = true;

_bc->getAuthenticationService()->authenticateTwitter(
    twitterId, token, secret, forceCreate, this);

Objective-C

NSString * twitterId = @"userTwitterId";
NSString * token = @"userAuthToken";
NSString * secret = @"secretFromTwitterApi";
BOOL forceCreate = true;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc authenticationService]
        authenticateTwitter:twitterId
                      token:token
                      secret:secret
                 forceCreate:forceCreate
             completionBlock:successBlock
        errorCompletionBlock:failureBlock
                    cbObject:nil];

Java

String twitterId = "userTwitterId";
String token = "userAuthToken";
String secret = "secretFromTwitterApi";
boolean forceCreate = true;
this; // implements IServerCallback

_bc.getAuthenticationService().authenticateTwitter(twitterId, token, secret, forceCreate, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var twitterId = "userTwitterId";
var token = "userAuthToken";
var secret = "secretFromTwitterApi";
var forceCreate = true;

_bc.authentication.authenticateTwitter(twitterId, token, secret, forceCreate, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  twitterId = "userTwitterId";
var  token = "userAuthToken";
var  secret = "secretFromTwitterApi";
var  forceCreate = true;

ServerResponse result = await _bc.authenticationService.authenticateTwitter(twitterId:twitterId, token:token, secret:secret, forceCreate:forceCreate);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

// N/A

Raw

// N/A

JSON Response

{
    "status": 200,
    "data": {
        "vcPurchased": 0,
        "experiencePoints": 100,
        "refundCount": 0,
        "playerSessionExpiry": 60,
        "server_time": 1464621990155,
        "experienceLevel": 0,
        "currency": {
            "credits": {
                "purchased": 0,
                "balance": 12211,
                "consumed": 133,
                "awarded": 12344
            }
        },
        "abTestingId": 8,
        "statistics": {
            "gamesWon": 0
        },
        "id": "323e861-b749-4ce4-a57a-175232e21b5d",
        "createdAt": 1459439058035,
        "profileId": "323e861-b749-4ce4-a57a-175232e21b5d",
        "newUser": "false",
        "xpCapped": false,
        "sent_events": [],
        "timeZoneOffset": -5,
        "playerName": "",
        "vcClaimed": 0,
        "parentProfileId": null,
        "rewards": {
            "rewardDetails": {},
            "rewards": {},
            "currency": {}
        },
        "countryCode": "ca",
        "loginCount": 16,
        "emailAddress": "test@email.com",
        "previousLogin": 1464621979514,
        "incoming_events": [],
        "lastLogin": 1464621990118,
        "languageCode": "en",
        "pictureUrl": null,
        "sessionId": "v3grtg3ve0a089pekk8lneuk8k",
        "amountSpent": 0
    }
}

Common Error Code

Status Codes

Code	Name	Description
40206	MISSING_IDENTITY_ERROR	The identity does not exist on the server and forceCreate was false [and a profileId was provided - otherwise 40208 would have been returned]. Will also occur when forceCreate is true and a saved [but un-associated] profileId is provided. The error handler should reset the stored profile id (if there is one) and re-authenticate, setting forceCreate to true to create a new account. A common cause of this error is deleting the user's account via the Design Portal.
40207	SWITCHING_PROFILES	Indicates that the identity credentials are valid, and the saved profileId is valid, but the identity is not associated with the provided profileId. This may indicate that the user wants to switch accounts in the app. Often an app will pop-up a dialog confirming that the user wants to switch accounts, and then reset the stored profileId and call authenticate again.
40208	MISSING_PROFILE_ERROR	Returned when the identity cannot be located, no profileId is provided, and forceCreate is false. The normal response is to call Authenticate again with forceCreate set to true.
40217	UNKNOWN_AUTH_ERROR	An unknown error has occurred during authentication.
40307	TOKEN_DOES_NOT_MATCH_USER	The user credentials are invalid (i.e. bad Twitter userId / token / secret). May also indicate that Twitter integration is not properly configured.