passport-intercom

Passport Intercom

Passport strategy for authenticating with Intercom using the OAuth 2.0 API.

This module lets you authenticate using Intercom in your Node.js applications. By plugging into Passport, Intercom authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Example Application

Install

$ npm install passport-intercom

NPM package

Usage

Configure Strategy

The Intercom authentication strategy authenticates users using a Intercom account and OAuth 2.0 tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a client ID, client secret, and callback URL.

passport.use(new IntercomStrategy({
    clientID: INTERCOM_CLIENT_ID,
    clientSecret: INTERCOM_CLIENT_SECRET,
    callbackURL: "http://localhost:3000/auth/intercom/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ intercomAdminId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'intercom' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/intercom',
  passport.authenticate('intercom'));

app.get('/auth/intercom/callback',
  passport.authenticate('intercom', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });

Examples

For a complete, working example, refer to passport-intercom-example-app.

Tests

$ npm install --dev
$ make test

Credits

Inspired by Jared Hanson's passport plugins.

License

The MIT License