JSPM

passport-cisco-spark-auth

1.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q38388F
  • License MIT

Passport strategy for authenticating with Cisco Webex

Package Exports

  • passport-cisco-spark-auth
  • passport-cisco-spark-auth/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (passport-cisco-spark-auth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CI

Passport - Cisco Spark

Passport strategy for authenticating with Cisco Spark using the OAuth 2.0 API.

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

Install

$ npm install passport-cisco-spark

Usage

Configure Strategy

The Cisco Spark authentication strategy authenticates users using a Cisco Spark 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 CiscoSparkStrategy({
    clientID: CISCO_SPARK_CLIENT_ID,
    clientSecret: CISCO_SPARK_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/spark/callback",
    passReqToCallback: true
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ sparkId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'cisco-spark' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/spark',
  passport.authenticate('cisco-spark'));

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

Optional Parameters:

  • passReqToCallback (default false) - directs passport to send the request object to the verfication callback

Credits

License

The MIT License