passport-purecloud

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

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

Install

$ npm install passport-purecloud

Usage

Create an Application

Before using passport-purecloud, you must register an application with PureCloud. If you have not already done so, a new application can be created at PureCloud Developer Center. Your application will be issued an client ID and client secret, which need to be provided to the strategy. You will also need to configure a redirect URI which matches the route in your application.

Configure Strategy

The PureCloud authentication strategy authenticates users using a PureCloud account and OAuth 2.0 tokens. The client ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a function, which receives the access token and optional refresh token, as well as profile which contains the authenticated user's PureCloud profile and a done callback which must be called cb providing a user to complete authentication.

var PureCloudStrategy = require('passport-purecloud').Strategy;

passport.use(new PureCloudStrategy({
    clientID: PURECLOUD_CLIENT_ID,
    clientSecret: PURECLOUD_CLIENT_SECRET,
    callbackURL: "http://localhost:3000/auth/purecloud/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ purecloudId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Credits

Jared Hanson

License

The MIT License