Skip to content

ConjureLabs/passport-bitbucket-oauth2

 
 

Repository files navigation

Passport-Bitbucket

CircleCI

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

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

Install

npm i --save passport-bitbucket-oauth2@git+https://github.com/ConjureLabs/passport-bitbucket-oauth2.git

Usage

Configure Strategy

The Bitbucket authentication strategy authenticates users using a Bitbucket account and OAuth tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a consumer key, consumer secret, and callback URL.

const BitbucketStrategy = require('passport-bitbucket-oauth2').Strategy

passport.use(
  new BitbucketStrategy({
    clientID: BITBUCKET_CLIENT_ID,
    clientSecret: BITBUCKET_CLIENT_SECRET,
    callbackURL: 'http://127.0.0.1:3000/auth/bitbucket/callback'
  },

  (accessToken, refreshToken, profile, done) => {
    User.findOrCreate({ bitbucketId: profile.id }, (err, user) => {
      done(err, user)
    })
  }
))

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/bitbucket', passport.authenticate('bitbucket'))

app.get(
  '/auth/bitbucket/callback',
  passport.authenticate('bitbucket', { failureRedirect: '/login' }),
  (req, res) => {
    // Successful authentication, redirect home.
    res.redirect('/')
  }
)

Tests

npm run lint
npm test

Credits

License

The MIT License

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

About

Bitbucket OAuth2 authentication strategy for Passport and Node.js.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 91.7%
  • Shell 8.3%