passport-apaoid

0.1.6 • Public • Published

Passport-Apaoid

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

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

Install

$ npm install passport-apaoid

Usage

Configure Strategy

The APAOID authentication strategy authenticates users using an APAOID 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.

The client ID and secret are obtained by registering an application at the Login with APAOID Developer Center.

passport.use(new ApaoidStrategy({
    clientID: APAOID_CLIENT_ID,
    clientSecret: APAOID_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/oauth2/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ apaoId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/oauth2/apaoid',
  passport.authenticate('apaoid'));

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

Examples

For a complete, working example, refer to the login example.

Tests

$ npm install --dev
$ make test

License

The MIT License

Copyright (c) 2015 Questwork <http://www.questwork.com/>

Package Sidebar

Install

npm i passport-apaoid

Weekly Downloads

0

Version

0.1.6

License

none

Last publish

Collaborators

  • questwork.support
  • don.lee