Node.js Linking Accounts

Sample Project

Download this sample project configured with your Auth0 API Keys.

System Requirements
  • NodeJS 4.3 or superior
  • Express 4.11
Show requirements

There may be situations where your users want to log in with multiple accounts that they own. In these cases, you may want to link these accounts together so that they are all reflected in the user's Auth0 profile. For example, if a user has signed up with email and password (which provides very little information about the user), you can ask the user to link their account to an OAuth provider like Facebook or Google to gain access to their social profile.

In this step, we'll modify the application we created in the Login step to allow users to link or unlink other OAuth providers to their account.

Show Linked Accounts Information

The user profile contains an array of identities which consists of profile information from all linked providers. You can verify this by accessing the Auth0 Users page, selecting a user and scrolling down to identities under Identity Provider Attributes.

This is how a profile looks after linking to Gmail:

User identities

If you fetch a profile containing linked accounts, you will have all this information available.

Linking Accounts

To link accounts, call the Link a user account Auth0 API endpoint. To complete the request, you must provide the primary account Auth0 JWT (the token provided when the user logged in), the user id (from the JWT or the profile API) and the JWT of the account you want to link (secondary account).

In order to get the user tokens, we must make a small modification to the Auth0Strategy configuration so that the user tokens are stored in the user object.

// app.js

// This will configure Passport to use Auth0
var strategy = new Auth0Strategy({
    domain:       process.env.AUTH0_DOMAIN,
    clientID:     process.env.AUTH0_CLIENT_ID,
    clientSecret: process.env.AUTH0_CLIENT_SECRET,
    callbackURL:  process.env.AUTH0_CALLBACK_URL || 'http://localhost:3000/callback'
  }, function(accessToken, refreshToken, extraParams, profile, done) {
    // Store the profile and tokens in the user object.
    return done(null, {
      profile: profile,
      extraParams: extraParams,

We need a new view called callback.jade that will help us store the primary user's JWT after a successful login in the client's localStorage.

extends layout

block content

    // Use local storage to keep track of the user's token and id.
    localStorage.setItem('idToken', '#{user.extraParams.id_token}')
    localStorage.setItem('userId', '#{}')

    window.location.href = '/user/';

Modify routes/index.js so that the /callback route renders the new template.

// routes/index.js

  passport.authenticate('auth0', {
    failureRedirect: '/url-if-something-fails',
  function(req, res) {
    res.render('callback', {
      env: env,
      user: req.user,

We now need to provide a means for the user to link another account. Let's add a Link Account button to views/user.jade that uses Auth0Lock to perform the secondary login.

// views/user.jade

extends layout

block content
  h2 Welcome #{user.profile.nickname}!
  a(href='/logout') Logout
  button(onclick="signin()") Link Account

    var lock = new Auth0Lock(
      '#{env.AUTH0_DOMAIN}', {
        auth: {
          redirectUrl: 'http://localhost:3000/link',
          responseType: 'token',

    function signin() {;

Let's now add a /link endpoint and create the template to be rendered when /link is reached.

// views/link.jade

extends layout

block content
  // We're using jQuery to do the POST request

    var lock = new Auth0Lock(

    lock.on("authenticated", function(authResult) {

    function linkAccount(secondaryJWT){
      // At this point you can fetch the secondary user_metadata for merging
      // with the primary account. Otherwise it will be lost after linking the accounts
      var primaryJWT = localStorage.getItem('idToken');
      var primaryUserId = localStorage.getItem('userId');
        type: 'POST',
        url: 'https://' + '#{env.AUTH0_DOMAIN}' + '/api/v2/users/' + primaryUserId + '/identities',
        data: {
          link_with: secondaryJWT
        headers: {
          'Authorization': 'Bearer ' + primaryJWT
        window.location.href = '/user/';
        alert('Error linking Accounts: ' + jqXHR.status + " " + jqXHR.responseText);

The linkAccount() function is in charge of sending a POST request to the Link a user account endpoint with both user tokens.

The /link endpoint simply renders the template. Add the following route to routes/index.js

// routes/index.js


  function(req, res) {
    res.render('link', {env: env});
Previous Tutorial
4. User Profile
Next Tutorial
6. Rules
Use Auth0 for FREECreate free Account