Provides an Ueberauth strategy for authenticating with Heroku.

Setup

Create an application in Heroku for you to use.

Register a new application at: your heroku developer page and get the client_id and client_secret.

Include the provider in your configuration for Ueberauth

config :ueberauth, Ueberauth,
  providers: [
    heroku: { Ueberauth.Strategy.Heroku, [] }
  ]

Then include the configuration for heroku.

config :ueberauth, Ueberauth.Strategy.Heroku.OAuth,
  client_id: System.get_env("HEROKU_CLIENT_ID"),
  client_secret: System.get_env("HEROKU_CLIENT_SECRET")

If you haven't already, create a pipeline and setup routes for your callback handler

pipeline :auth do
  Ueberauth.plug "/auth"
end

scope "/auth" do
  pipe_through [:browser, :auth]

  get "/:provider/callback", AuthController, :callback
end

Create an endpoint for the callback where you will handle the Ueberauth.Auth struct

defmodule MyApp.AuthController do
  use MyApp.Web, :controller

  def callback_phase(%{ assigns: %{ ueberauth_failure: fails } } = conn, _params) do
    # do things with the failure
  end

  def callback_phase(%{ assigns: %{ ueberauth_auth: auth } } = conn, params) do
    # do things with the auth
  end
end

You can edit the behaviour of the Strategy by including some options when you register your provider.

To set the default 'scopes' (permissions):

config :ueberauth, Ueberauth,
  providers: [
    heroku: { Ueberauth.Strategy.Heroku, [default_scope: "identity,read"] }
  ]

Deafult is "identity"