mkacper / ueberauth_auth0

[MAINTAINERS NEEDED] Auth0 OAuth2 strategy for Überauth.

Überauth Auth0

Auth0 OAuth2 strategy for Überauth.

Installation

1. Set up your Auth0 application at Auth0 dashboard

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

def deps do
  [{:ueberauth_auth0, "~> 0.3"}]
end

3. Ensure ueberauth_auth0 is started before your application:

def application do
  [applications: [:ueberauth_auth0]]
end

4. Add Auth0 to your Überauth configuration:

config :ueberauth, Ueberauth,
  providers: [
    auth0: {Ueberauth.Strategy.Auth0, []}
  ],
  # If you wish to customize the OAuth serializer,
  # add the line below. Defaults to Jason.
  json_library: Poison

5. Update your provider configuration:

config :ueberauth, Ueberauth.Strategy.Auth0.OAuth,
  domain: System.get_env("AUTH0_DOMAIN"),
  client_id: System.get_env("AUTH0_CLIENT_ID"),
  client_secret: System.get_env("AUTH0_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. You controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth Example application.

Changelog

ueberauth_auth0 follows semantic versioning. See CHANGELOG.md for more information.

License

MIT. Please see LICENSE for licensing details.