Skip to content

DavidSpriggs/passport-arcgis

Repository files navigation

Passport-ArcGIS

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

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

Install

$ npm install passport-arcgis

Usage

Configure Strategy

The ArcGIS authentication strategy authenticates users using a ArcGIS 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 ArcGISStrategy({
    clientID: ARCGIS_CLIENT_ID,
    clientSecret: ARCGIS_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/arcgis/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ username: profile.username }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

For a complete, working example, refer to the login example.

ArcGIS Oauth2 api and discussion.

Tests

$ npm install --dev
$ make test

Credits

License

The MIT License

About

passport strategy for arcgis.com oauth2

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published