Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decioferreira/omniauth-linkedin-oauth2
A LinkedIn OAuth2 strategy for OmniAuth.
https://github.com/decioferreira/omniauth-linkedin-oauth2
Last synced: 3 months ago
JSON representation
A LinkedIn OAuth2 strategy for OmniAuth.
- Host: GitHub
- URL: https://github.com/decioferreira/omniauth-linkedin-oauth2
- Owner: decioferreira
- License: mit
- Created: 2013-03-02T18:54:23.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T11:04:25.000Z (6 months ago)
- Last Synced: 2024-10-01T08:39:34.607Z (4 months ago)
- Language: Ruby
- Size: 59.6 KB
- Stars: 117
- Watchers: 12
- Forks: 147
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- my-awesome-rails-gem - omniauth-linkedin-oauth2
- awesome-rails-gem - omniauth-linkedin-oauth2
README
# OmniAuth LinkedIn OAuth2 Strategy
A LinkedIn OAuth2 strategy for OmniAuth.
For more details, read the LinkedIn documentation: https://learn.microsoft.com/en-us/linkedin/shared/authentication/authentication
> This version of Sign In with LinkedIn has been deprecated as of August 1, 2023. For all Sign In with LinkedIn implementations going forward, please refer to [Sign In with LinkedIn using OpenID Connect](https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2).
## Sign In with LinkedIn using OpenID Connect
LinkedIn is now offering a way for your apps to authenticate members using OpenID Connect (OIDC).
You should install the new `gem 'omniauth-linkedin-openid'` for this purpose. You can find it at
[jclusso/omniauth-linkedin-openid](https://github.com/jclusso/omniauth-linkedin-openid).
## Installation
Add this gem to your application's Gemfile:
bundle add omniauth-linkedin-oauth2
Or install it yourself as:
$ gem install omniauth-linkedin-oauth2
## Upgrading
This version is a major upgrade to the LinkedIn API version 2. As such, it switches from the soon to be no longer available `r_basicprofile` to `r_liteprofile`. This results in a much limited set of data that we can get from LinkedIn.
Previous versions of this gem used the provider name `:linkedin_oauth2`. In order to provide a cleaner upgrade path for users who were previously using the OAuth 1.0 omniauth adapter for LinkedIn [https://github.com/skorks/omniauth-linkedin], this has been renamed to just `:linkedin`.
Users who are upgrading from previous versions of this gem may need to update their Omniauth and/or Devise configurations to use the shorter provider name.
## Usage
Register your application with LinkedIn to receive an API key: https://www.linkedin.com/developers/apps
This is an example that you might put into a Rails initializer at `config/initializers/omniauth.rb`:
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :linkedin, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET']
end
```
You can now access the OmniAuth LinkedIn OAuth2 URL: `/auth/linkedin`.
## Granting Member Permissions to Your Application
With the LinkedIn API, you have the ability to specify which permissions you want users to grant your application.
For more details, read the LinkedIn documentation: https://developer.linkedin.com/docs/oauth2
By default, omniauth-linkedin-oauth2 requests the following permissions:
'r_liteprofile r_emailaddress'
You can configure the scope option:
```ruby
provider :linkedin, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET'], :scope => 'r_liteprofile'
```
## Profile Fields
When specifying which permissions you want to users to grant to your application, you will probably want to specify the array of fields that you want returned in the omniauth hash. The list of default fields is as follows:
```ruby
['id', 'first-name', 'last-name', 'picture-url', 'email-address']
```
Here's an example of a possible configuration where the fields returned from the API are: id, first-name and last-name.
```ruby
provider :linkedin, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET'], :fields => ['id', 'first-name', 'last-name']
```
To see a complete list of available fields, consult the LinkedIn documentation at: https://developer.linkedin.com/docs/fields
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request