ueberauth_intercom

Ueberauth strategy for Intercom authentication.


Keywords
authentication, elixir, oauth, oauth2
License
Other

Documentation

Überauth Intercom

Intercom OAuth2 strategy for Überauth.

Installation

  1. Setup your OAuth following the guides on Intercom Developer Hub.

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

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

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

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

    config :ueberauth, Ueberauth.Strategy.Intercom.OAuth,
      client_id: System.get_env("INTERCOM_CLIENT_ID"),
      client_secret: System.get_env("INTERCOM_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 initial the request through:

/auth/intercom?state=csrf_token_here

License

Please see LICENSE for licensing details.