\n Advertisement\n \n The Complete Node.js Developer Course Learn Node. js by building real-world applications with Node, Express, MongoDB, Jest, and more!\n
\n\n---\n\n[](https://www.npmjs.com/package/passport-twitter)\n[](https://travis-ci.org/jaredhanson/passport-twitter)\n[](https://coveralls.io/github/jaredhanson/passport-twitter)\n[...](https://github.com/jaredhanson/passport-twitter/wiki/Status)\n\n## Install\n\n```bash\n$ npm i @passport-js/passport-twitter\n```\n\n## Usage\n\n#### Create an Application\n\nBefore using `passport-twitter`, you must register an application with Twitter.\nIf you have not already done so, a new application can be created at\n[Twitter Application Management](https://apps.twitter.com/). Your application\nwill be issued a consumer key (API Key) and consumer secret (API Secret), which\nneed to be provided to the strategy. You will also need to configure a callback\nURL which matches the route in your application.\n\n#### Configure Strategy\n\nThe Twitter authentication strategy authenticates users using a Twitter account\nand OAuth tokens. The consumer key and consumer secret obtained when creating\nan application are supplied as options when creating the strategy. The strategy\nalso requires a `verify` callback, which receives the access token and\ncorresponding secret as arguments, as well as `profile` which contains the\nauthenticated user's Twitter profile. The `verify` callback must call `cb`\nproviding a user to complete authentication.\n\n```javascript\npassport.use(new TwitterStrategy({\n consumerKey: TWITTER_CONSUMER_KEY,\n consumerSecret: TWITTER_CONSUMER_SECRET,\n callbackURL: \"http://127.0.0.1:3000/auth/twitter/callback\"\n },\n function(token, tokenSecret, profile, cb) {\n User.findOrCreate({ twitterId: profile.id }, function (err, user) {\n return cb(err, user);\n });\n }\n));\n```\n\n#### Authenticate Requests\n\nUse `passport.authenticate()`, specifying the `'twitter'` strategy, to\nauthenticate requests.\n\nFor example, as route middleware in an [Express](http://expressjs.com/)\napplication:\n\n```javascript\napp.get('/auth/twitter',\n passport.authenticate('twitter'));\n\napp.get('/auth/twitter/callback', \n passport.authenticate('twitter', { failureRedirect: '/login' }),\n function(req, res) {\n // Successful authentication, redirect home.\n res.redirect('/');\n });\n```\n\n## Examples\n\nDevelopers using the popular [Express](http://expressjs.com/) web framework can\nrefer to an [example](https://github.com/passport/express-4.x-twitter-example)\nas a starting point for their own web applications.\n\n## License\n\n[The MIT License](http://opensource.org/licenses/MIT)\n\nCopyright (c) 2011-2016 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>\n","readmeFilename":"README.md"}