This Strategy was modifed directly from Jared Hanson's passport-facebook OAuth 2.0 Strategy and passport-twitter OAuth 1.0a Strategy modules. This project was taken and modified and released to support Twitter OAuth 2.0 pipelines
This module lets you authenticate using Twitter in your Node.js applications. By plugging into Passport, Twitter authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
$ npm install passport-twitter-oauth2
Create an Application
passport-twitter-oauth2, you must register an application with
Twitter. If you have not already done so, a new application can be created at
Twitter Apps. Your application will
be issued an app ID and app secret, which need to be provided to the strategy.
You will also need to configure a redirect URI which matches the route in your
The Twitter authentication strategy authenticates users using a Twitter
account and OAuth 2.0 tokens. The app ID and secret obtained when creating an
application are supplied as options when creating the strategy. The strategy
also requires a
verify callback, which receives the access token and optional
refresh token, as well as
profile which contains the authenticated user's
Twitter profile. The
verify callback must call
cb providing a user to
passport.authenticate(), specifying the
'twitter' strategy, to
For example, as route middleware in an Express application:
How do I ask a user for additional permissions?
If you need additional permissions from the user, the permissions can be
requested via the
scope option to
Refer to permissions with Twitter Login for further details.
How do I re-ask for for declined permissions?
authType option to
rerequest when authenticating.
How do I obtain a user profile with specific fields?
The Twitter profile contains a lot of information about a user. By default,
not all the fields in a profile are returned. The fields needed by an application
can be indicated by setting the
clientID: TWITTER_APP_ID clientSecret: TWITTER_APP_SECRET callbackURL: "" profileFields: 'id' 'displayName' 'photos' 'email' ...)
How do I obtain a user's email address?
includeEmail option when creating the strategy.
clientID: TWITTER_APP_ID clientSecret: TWITTER_APP_SECRET callbackURL: "" includeEmail: true ...
The test suite is located in the
test/ directory. All new features are
expected to have corresponding test cases. Ensure that the complete test suite
passes by executing:
$ make test
The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing:
$ make test-cov$ make view-cov
Copyright (c) 2016-2018 Balanced Media Technlogy, LLC <http://hewmen.io/>