https://github.com/jaredhanson/passport-linkedin
LinkedIn authentication strategy for Passport and Node.js.
https://github.com/jaredhanson/passport-linkedin
Last synced: about 1 year ago
JSON representation
LinkedIn authentication strategy for Passport and Node.js.
- Host: GitHub
- URL: https://github.com/jaredhanson/passport-linkedin
- Owner: jaredhanson
- License: mit
- Created: 2011-10-30T22:59:38.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2022-10-25T00:07:16.000Z (over 3 years ago)
- Last Synced: 2025-04-19T14:49:23.285Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.passportjs.org/packages/passport-linkedin/?utm_source=github&utm_medium=referral&utm_campaign=passport-linkedin&utm_content=about
- Size: 37.1 KB
- Stars: 141
- Watchers: 9
- Forks: 66
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Passport-LinkedIn
[Passport](http://passportjs.org/) strategy for authenticating with [LinkedIn](http://www.linkedin.com/)
using the OAuth 1.0a API.
This module lets you authenticate using LinkedIn in your Node.js applications.
By plugging into Passport, LinkedIn 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/).
:heart: [Sponsors](https://www.passportjs.org/sponsors/?utm_source=github&utm_medium=referral&utm_campaign=passport-linkedin&utm_content=nav-sponsors)
---
1Password, the only password manager you should trust. Industry-leading security and award winning design.
---
[](https://www.npmjs.com/package/passport-linkedin)
[](https://travis-ci.org/jaredhanson/passport-linkedin)
[](https://coveralls.io/github/jaredhanson/passport-linkedin)
[...](https://github.com/jaredhanson/passport-linkedin/wiki/Status)
## Install
$ npm install passport-linkedin
## Usage
#### Configure Strategy
The LinkedIn authentication strategy authenticates users using a LinkedIn
account and OAuth tokens. The strategy requires a `verify` callback, which
accepts these credentials and calls `done` providing a user, as well as
`options` specifying a consumer key, consumer secret, and callback URL.
passport.use(new LinkedInStrategy({
consumerKey: LINKEDIN_API_KEY,
consumerSecret: LINKEDIN_SECRET_KEY,
callbackURL: "http://127.0.0.1:3000/auth/linkedin/callback"
},
function(token, tokenSecret, profile, done) {
User.findOrCreate({ linkedinId: profile.id }, function (err, user) {
return done(err, user);
});
}
));
#### Authenticate Requests
Use `passport.authenticate()`, specifying the `'linkedin'` strategy, to
authenticate requests.
For example, as route middleware in an [Express](http://expressjs.com/)
application:
app.get('/auth/linkedin',
passport.authenticate('linkedin'));
app.get('/auth/linkedin/callback',
passport.authenticate('linkedin', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
#### Extended Permissions
If you need extended permissions from the user, the permissions can be requested
via the `scope` option to `passport.authenticate()`.
For example, this authorization requests permission to the user's basic profile
and email address:
app.get('/auth/linkedin',
passport.authenticate('linkedin', { scope: ['r_basicprofile', 'r_emailaddress'] }));
#### Profile Fields
The LinkedIn profile is very rich, and may contain a lot of information. The
strategy can be configured with a `profileFields` parameter which specifies a
list of fields your application needs. For example, to fetch the user's ID, name,
email address, and headline, configure strategy like this.
passport.use(new LinkedInStrategy({
// clientID, clientSecret and callbackURL
profileFields: ['id', 'first-name', 'last-name', 'email-address', 'headline']
},
// verify callback
));
## Examples
For a complete, working example, refer to the [login example](https://github.com/jaredhanson/passport-linkedin/tree/master/examples/login).
## Tests
$ npm install --dev
$ make test
## 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/)>