https://github.com/ewgenius/passport-yoke

Yoke-id authentication strategy for Passport
https://github.com/ewgenius/passport-yoke

Last synced: 11 months ago
JSON representation

Yoke-id authentication strategy for Passport

• Host: GitHub
• URL: https://github.com/ewgenius/passport-yoke
• Owner: ewgenius
• License: mit
• Created: 2014-08-12T11:53:36.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2014-08-12T12:38:40.000Z (almost 12 years ago)
• Last Synced: 2025-04-06T19:39:19.918Z (about 1 year ago)
• Language: JavaScript
• Size: 203 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Passport-Instagram

[Passport](https://github.com/jaredhanson/passport) strategy for authenticating

with [Instagram](http://instagr.am/) using the OAuth 2.0 API.

This module lets you authenticate using Instagram in your Node.js applications.

By plugging into Passport, Instagram authentication can be easily and

unobtrusively integrated into any application or framework that supports

[Connect](http://www.senchalabs.org/connect/)-style middleware, including

[Express](http://expressjs.com/).

## Install

    $ npm install passport-instagram

## Usage

#### Configure Strategy

The Instagram authentication strategy authenticates users using a Instagram

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 InstagramStrategy({

        clientID: INSTAGRAM_CLIENT_ID,

        clientSecret: INSTAGRAM_CLIENT_SECRET,

        callbackURL: "http://127.0.0.1:3000/auth/instagram/callback"

      },

      function(accessToken, refreshToken, profile, done) {

        User.findOrCreate({ instagramId: profile.id }, function (err, user) {

          return done(err, user);

        });

      }

    ));

#### Authenticate Requests

Use `passport.authenticate()`, specifying the `'instagram'` strategy, to

authenticate requests.

For example, as route middleware in an [Express](http://expressjs.com/)

application:

    app.get('/auth/instagram',

      passport.authenticate('instagram'));

    app.get('/auth/instagram/callback', 

      passport.authenticate('instagram', { failureRedirect: '/login' }),

      function(req, res) {

        // Successful authentication, redirect home.

        res.redirect('/');

      });

## Examples

For a complete, working example, refer to the [login example](https://github.com/jaredhanson/passport-instagram/tree/master/examples/login).

## Tests

    $ npm install --dev

    $ make test

[![Build Status](https://secure.travis-ci.org/jaredhanson/passport-instagram.png)](http://travis-ci.org/jaredhanson/passport-instagram)

## Credits

  - [Jared Hanson](http://github.com/jaredhanson)

## License

[The MIT License](http://opensource.org/licenses/MIT)

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