Skip to content

HireHipo/ueberauth_linkedin

This branch is 16 commits ahead of fajarmf/ueberauth_linkedin:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c8c2904 · Jul 25, 2024

History

50 Commits
Jul 23, 2024
Jul 25, 2024
Apr 6, 2016
Oct 19, 2021
Sep 24, 2020
Aug 19, 2019
Oct 19, 2021
Apr 6, 2016
Oct 19, 2021
Jul 25, 2024
Jul 25, 2024

Repository files navigation

Überauth LinkedIn

Build Status Hex Version License

LinkedIn OAuth2 strategy for Überauth.

Installation

  1. Setup your application at LinkedIn Developers.

  2. Add :ueberauth_linkedin to your list of dependencies in mix.exs:

    def deps do
      [{:ueberauth_linkedin, "~> 0.3"}]
    end
  3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_linkedin]]
    end
  4. Add LinkedIn to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        linkedin: {Ueberauth.Strategy.LinkedIn, []}
      ]
  5. Update your provider configuration:

    config :ueberauth, Ueberauth.Strategy.LinkedIn.OAuth,
      client_id: System.get_env("LINKEDIN_CLIENT_ID"),
      client_secret: System.get_env("LINKEDIN_CLIENT_SECRET")
  6. Include the Überauth plug in your controller:

    defmodule MyApp.AuthController do
      use MyApp.Web, :controller
      plug Ueberauth
      ...
    end
  7. Create the request and callback routes if you haven't already:

    scope "/auth", MyApp do
      pipe_through :browser
    
      get "/:provider", AuthController, :request
      get "/:provider/callback", AuthController, :callback
    end
  8. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth Example application.

Calling

Depending on the configured url you can initiate the request through:

/auth/linkedin

Or with scope:

/auth/linkedin?scope=r_emailaddress

By default the requested scope is "r_liteprofile r_emailaddress". Scope can be configured either explicitly as a scope query value on the request path or in your configuration:

config :ueberauth, Ueberauth,
  providers: [
    linkedin: {Ueberauth.Strategy.LinkedIn, [default_scope: "r_liteprofile r_emailaddress"]}
  ]

License

Please see LICENSE for licensing details.

About

LinkedIn OAuth2 Strategy for Überauth.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Elixir 100.0%