Box: Authorize a User with OAuth 2.0

See more Box Examples

Interactive local-development example using a browser and a loopback callback. Register exactly http://localhost:3017/ in the Box User app. Run this in a trusted environment that can hold the client secret. A deployed web app must handle its registered HTTPS callback on the server.

See the Box API guide for setup and the complete workflow.

var success = false;

//  Requires Chilkat 11.5.0 or later and a previously unlocked Chilkat bundle.
//  See Global Unlock Sample.
//  Guide: Box API Guide.

success = false;

var oauth2 = new CkOAuth2();
oauth2.ListenPort = 3017;
oauth2.AuthorizationEndpoint = "https://account.box.com/api/oauth2/authorize";
oauth2.TokenEndpoint = "https://api.box.com/oauth2/token";
oauth2.ClientId = "BOX_CLIENT_ID";
oauth2.ClientSecret = "BOX_CLIENT_SECRET";
//  Use Box's documented confidential-client authorization-code flow.
oauth2.CodeChallenge = false;
var url = oauth2.StartAuth();
if (oauth2.LastMethodSuccess !== true) {
    console.log(oauth2.LastErrorText);
    return;
}

success = oauth2.LaunchBrowser(url);
if (success !== true) {
    console.log(oauth2.LastErrorText);
    return;
}

var elapsedMs = 0;
while ((elapsedMs < 120000) && (oauth2.AuthFlowState < 3)) {
    oauth2.SleepMs(100);
    elapsedMs = elapsedMs+100;
}

if (oauth2.AuthFlowState < 3) {
    oauth2.Cancel();
    console.log("Authorization timed out.");
    return;
}

if (oauth2.AuthFlowState !== 3) {
    console.log("Authorization was denied or failed. State: " + oauth2.AuthFlowState);
    return;
}

//  Retain both tokens in your application's protected token store.
//  The variables below are deliberately not printed.
var accessToken = oauth2.AccessToken;
var refreshToken = oauth2.RefreshToken;
//  For this local-development example only, save in a directory restricted to this user.
//  Create qa_data/tokens before running; never put this file under a web root.
var tokens = new CkJsonObject();
success = tokens.Load(oauth2.AccessTokenResponse);
if (success !== true) {
    console.log(tokens.LastErrorText);
    return;
}

success = tokens.WriteFile("qa_data/tokens/box_oauth.json");
if (success !== true) {
    console.log(tokens.LastErrorText);
    return;
}

console.log("Authorization complete; token response saved in the protected local token file.");