@lamkoti/passport-contentstack

Passport-Contentstack

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

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

Installation

$ npm install @lamkoti/passport-contentstack

Usage

Configure Strategy

The Contentstack authentication strategy authenticates users using a Contentstack 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 ContentstackStrategy({
    clientID: CONTENTSTACK_CLIENT_ID,
    clientSecret: CONTENTSTACK_CLIENT_SECRET,
    authorizationURL:
      "https://app.contentstack.com/apps/<APP_INSTALLATION_UID>/authorize",
    callbackURL: "http://localhost:3000/auth/callback",
    region: "<NA|EU|AZURE_NA|AZURE_EU>",
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ email: profile.email }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

app.get('/auth/contentstack/callback', 
  passport.authenticate('contentstack', { 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

Credits

• Jared Hanson
• Ravi Lamkoti

License

The MIT License

Copyright (c) 2011-2013 Jared Hanson <http://jaredhanson.net/>