Skip to content

feedbackfruits/passport-brightspace

Repository files navigation

passport-brightspace

CircleCIcodecov

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

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

Install

$ npm install passport-brightspace

Usage

Configure Strategy

The Brightspace authentication strategy authenticates users using a Brightspace 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 BrightspaceStrategy({
    host: BRIGHTSPACE_HOST,
    clientID: BRIGHTSPACE_CLIENT_ID,
    clientSecret: BRIGHTSPACE_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/brightspace/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ brightspaceId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/brightspace',
  passport.authenticate('brightspace', { }));

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

Tests

$ npm install --only=dev
$ make test

License

The MIT License

About

Brightspace authentication via OAuth 2.0 with Passport

Resources

License

Stars

Watchers

Forks

Packages

No packages published