passport-chiiv
v0.1.0
Published
OAuth2 client authentication for Chiiv using passport.js
Downloads
2
Maintainers
Readme
Passport.js authentication for Chiiv
Passport strategy for authenticating with Chiiv using the OAuth 2.0 API.
This module lets you authenticate using Chiiv in your Node.js applications.
By plugging into Passport, Chiiv authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
Install
npm install passport-chiiv
Usage
Configure Strategy
The Chiiv authentication strategy authenticates users using a Chiiv 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 ChiivOAuth2Strategy({
clientID: CLIENT_ID,
clientSecret: CLIENT_SECRET,
callbackURL: "https://www.example.net/auth/chiiv/callback"
},
function(accessToken, refreshToken, profile, done) {
User.findOrCreate({ providerId: profile.id }, function (err, user) {
return done(err, user);
});
}
));
Authenticate Requests
Use passport.authenticate()
, specifying the 'chiiv'
strategy, to authenticate requests.
For example, as route middleware in an Express application:
app.get('/auth/chiiv',
passport.authenticate('chiiv'));
app.get('/auth/chiiv/callback',
passport.authenticate('chiiv', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
Credits
Initiated by Makis Tracend
Part of Chiiv by K&D Interactive
Released under the MIT license