passport-twitch-token

3.0.0 • Public • Published

passport-twitch-token

Build Status Coverage

Downloads Downloads npm version License

Passport strategy for authenticating with Twitch access tokens using the OAuth 2.0 API.

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

Installation

npm install passport-twitch-token

Usage

Configure Strategy

The Twitch authentication strategy authenticates users using a Twitch account and OAuth 2.0 tokens. The strategy requires a verify callback, which accepts these credentials and calls next providing a user, as well as options specifying a app ID and app secret.

var TwitchTokenStrategy = require('passport-twitch-token');
 
passport.use(new TwitchTokenStrategy({
    clientID: TWITCH_CLIENT_ID,
    clientSecret: TWITCH_CLIENT_SECRET,
    passReqToCallback: true
}, function(req, accessToken, refreshToken, profile, next) {
    User.findOrCreate({'twitch.id': profile.id}, function(error, user) {
        return next(error, user);
    });
}));

Authenticate Requests

Use passport.authenticate(), specifying the twitch-token strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/twitch', passport.authenticate('twitch-token'));

Or if you are using Sails framework:

// AuthController.js
module.exports = {
    twitch: function(req, res) {
        passport.authenticate('twitch-token', function(error, user, info) {
            if (error) return res.serverError(error);
            if (info) return res.unauthorized(info);
            return res.ok(user);
        })(req, res);
    }
};

The request to this route should include a GET or POST data with the keys access_token and optionally, refresh_token set to the credentials you receive from Twitch.

GET /auth/twitch?access_token=<TOKEN>

Issues

If you receive a 401 Unauthorized error, it is most likely because you have wrong access token or not yet specified any application permissions. Once you refresh access token with new permissions, try to send this access token again.

License

The MIT License (MIT)

Dependents (0)

Package Sidebar

Install

npm i passport-twitch-token

Weekly Downloads

11

Version

3.0.0

License

MIT

Unpacked Size

9.21 kB

Total Files

4

Last publish

Collaborators

  • ghaiklor