auth0-js

Auth0 headless browser sdk

Auth0.js

Auth0 is an authentication broker that supports social identity providers as well as enterprise identity providers such as Active Directory, LDAP, Office365, Google Apps, Salesforce.

Auth0.js is a client-side library for Auth0. It allows you to trigger the authentication process and parse the JWT (JSON web token) with just the Auth0 clientID. Once you have the JWT you can use it to authenticate requests to your http API and validate the JWT in your server-side logic with the clientSecret.

The example directory has a ready-to-go app. In order to run it you need node installed, download dependencies with npm install, then execute npm run example from the root of this project.

Take auth0.js or auth0.min.js from the /build directory and import it to your page.

If you are using browserify install with npm i auth0-js --production --save.

Note: The following examples use jQuery, but auth0.js is not tied to jQuery and any library can be used with it.

Construct a new instance of the Auth0 client as follows:

<script src="http://cdn.auth0.com/w2/auth0-4.js"></script>
<script type="text/javascript">
  var auth0 = new Auth0({
    domain:       'mine.auth0.com',
    clientID:     'dsa7d77dsa7d7',
    callbackURL:  'http://my-app.com/callback',
    callbackOnLocationHash: true
  });
 
  //... 
</script> 

Trigger the login on any of your active identity provider as follows:

  //trigger login with google 
  $('.login-google').click(function () {
    auth0.login({
      connection: 'google-oauth2'
    });
  });
 
  //trigger login with github 
  $('.login-github').click(function () {
    auth0.login({
      connection: 'github'
    });
  });
 
  //trigger login with an enterprise connection 
  $('.login-github').click(function () {
    auth0.login({
      connection: 'contoso.com'
    });
  });
 
  //trigger login with a db connection 
  $('.login-dbconn').click(function () {
    auth0.login({
      connection: 'db-conn',
      username:   $('.username').val(),
      password:   $('.password').val(),
    });
  });
 
  //trigger login with a db connection and avoid the redirect (best experience for SPA) 
  $('.login-dbconn').click(function () {
    auth0.login({
      connection: 'db-conn',
      username:   $('.username').val(),
      password:   $('.password').val(),
    },
    function (errprofileid_tokenaccess_token) {
      // store in cookies 
    });
  });
 
  //trigger login popup with google 
  $('.login-google-popup').click(function (e) {
    e.preventDefault();
    auth0.login({
      connection: 'google-oauth2',
      popup: true,
      popupOptions: {
        width: 450,
        height: 800
      }
    }, function(errprofileid_tokenaccess_tokenstate) {
      if (err) {
        alert("something went wrong: " + err.message);
        return;
      }
      alert('hello ' + profile.name);
    });
  });

You can also request scopes that are not were not configured for the connection.

  //trigger login requesting additional scopes with google 
  $('.login-google').click(function () {
    auth0.login({
      connection: 'google-oauth2',
      connection_scope: ['https://www.googleapis.com/auth/orkut', 'https://picasaweb.google.com/data/']
    });
  });
 
  // alternatively a comma separated list also works 
  $('.login-google').click(function () {
    auth0.login({
      connection: 'google-oauth2',
      connection_scope: 'https://www.googleapis.com/auth/orkut,https://picasaweb.google.com/data/'
    });
  });

Trigger the login with offline mode support to get the refresh_token

$('.login-dbconn').click(function () {
    auth0.login({
      connection: 'db-conn',
      username:   $('.username').val(),
      password:   $('.password').val(),
      scope: 'openid offline_access'
    },
    function (errprofileid_tokenaccess_tokenstaterefresh_token) {
      // store in cookies 
      // refresh_token is sent because offline_access is set as a scope 
    });
  });

Once you have succesfully authenticated, Auth0 will redirect to your callbackURL with a hash containing an access_token and the jwt (id_token). You can parse the hash and retrieve the full user profile as follows:

  $(function () {
    var result = auth0.parseHash(window.location.hash);
 
    //use result.id_token to call your rest api 
 
    if (result && result.id_token) {
      auth0.getProfile(result.id_token, function (errprofile) {
        alert('hello ' + profile.name);
      });
      // If offline_access was a requested scope 
      // You can grab the result.refresh_token here 
 
    } else if (result && result.error) {
      alert('error: ' + result.error);
    }
  });

Or just parse the hash (if loginOption.scope is not openid profile, then the profile will only contains the user_id):

  $(function () {
      var result = auth0.parseHash(window.location.hash);
      if (result && result.profile) {
        alert('your user_id is: ' + result.profile.sub);
        //use result.id_token to call your rest api 
      }
    });
  });

If there is no hash, result will be null. It the hash contains the jwt, the profile field will be populated.

While using this mode, the result will be passed as the login method callback.

  auth0.login({ popup: true }, function(errprofileid_tokenaccess_tokenstaterefresh_token) {
    if (err) {
      // Handle the error! 
      return;
    }
 
    //use id_token to call your rest api 
    alert('hello ' + profile.name);
 
    // refresh_token is sent only if offline_access is set as a scope 
  });
});

When using database connection there are two possible modes:

  • Resource Owner endpoint (/ro)enabled by passing sso: false (default): Performs a CORS POST request against the former endpoint (or in IE8 or 9 perform a JSONP request). This endpoint allows users to authenticate by sending their username and password and returning a JWT. This does not set any cookie and no popup is opened (even with popup set to true).

  • SSO mode enabled by passing sso: true: In this case, a popup is created in which the authentication takes place. Sets the SSO cookie and prompts for a multifactor authentication code, if enabled.

If you use Database Connections you can signup as follows:

  $('.signup').click(function () {
    auth0.signup({
      connection: 'db-conn',
      username:   'foo@bar.com',
      password:   'blabla'
    }, function (err) {
      console.log(err.message);
    });
  });

After a succesful login it will auto login the user. If you do not want to automatically login the user you have to pass the option auto_login: false.

  $('.change_password').click(function () {
    auth0.changePassword({
      connection: 'db-conn',
      username:   'foo@bar.com',
      password:   'blabla' // new password 
    }, function (errresp) {
      console.log(err.message);
    });
  });

A delegation token is a new token for a different service or app/API.

If you just want to get a new token for an addon that you've activated, you can do the following:

var options = {
  id_token: "your id token", // The id_token you have now 
  api: 'firebase', // This defaults to the first active addon if any or you can specify this 
  "scope": "openid profile"         // default: openid 
};
 
auth0.getDelegationToken(options, function (errdelegationResult) {
    // Call your API using delegationResult.id_token 
});

If you want to get the token for another API or App:

var options = {
  id_token: "your id token", // The id_token you have now 
  api: 'auth0' // This is default when calling another app that doesn't have an addon 
  targetClientId: 'The other client id'
};
 
auth0.getDelegationToken(options, function (errdelegationResult) {
  // Call your API using delegationResult.id_token 
});

If you want to refresh your existing (not expired) token, you can just do the following:

auth0.renewIdToken(current_id_token, function (errdelegationResult) {
  // Get here the new delegationResult.id_token 
});

If you want to refresh your existing (expired) token, if you have the refresh_token, you can call the following:

auth0.refreshToken(refresh_token, function (errdelegationResult) {
  // Get here the new delegationResult.id_token 
});

You can validate a user of a specific connection with his username and password:

auth0.validateUser({
  connection:   'db-conn',
  username:     'foo@bar.com',
  password:     'blabla'
}, function (errvalid) { });

Method getSSOData fetches Single Sign-On information:

  auth0.getSSOData(function (errssoData) {
    if (err) return console.log(err.message);
    expect(ssoData.sso).to.exist;
  });

Load Active Directory data if available (Kerberos):

  auth0.getSSOData(true, fn);

When Kerberos is available you can automatically trigger Windows Authentication. As a result the user will immediately be authenticated without taking any action.

  auth0.getSSOData(true, function (errssoData) {
    if (!err && ssoData && ssoData.connection) {
      auth0.login({ connection: ssoData.connection });
    }
  });

Run grunt dev and point your browser to http://localhost:9999/test_harness.html to run the test suite.

Run grunt phantom if you have PhantomJS installed.

Run grunt integration (or npm test) if you have SauceLabs account. You will need a SAUCE_ACCESS_KEY and SAUCE_USERNAME env variables.

Use:

$ ./bin/version patch
$ git push origin master

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Auth0

This project is licensed under the MIT license. See the LICENSE file for more info.