Facebook OAuth2 strategy for Überauth.
-
Setup your application at Facebook Developers.
-
Add
:ueberauth_facebook
to your list of dependencies inmix.exs
:def deps do [{:ueberauth_facebook, "~> 0.3"}] end
-
Add the strategy to your applications:
def application do [applications: [:ueberauth_facebook]] end
-
Add Facebook to your Überauth configuration:
config :ueberauth, Ueberauth, providers: [ facebook: {Ueberauth.Strategy.Facebook, []} ]
-
Update your provider configuration:
config :ueberauth, Ueberauth.Strategy.Facebook.OAuth, client_id: System.get_env("FACEBOOK_CLIENT_ID"), client_secret: System.get_env("FACEBOOK_CLIENT_SECRET")
-
Include the Überauth plug in your controller:
defmodule MyApp.AuthController do use MyApp.Web, :controller plug Ueberauth ... end
-
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
-
Your controller needs to implement callbacks to deal with
Ueberauth.Auth
andUeberauth.Failure
responses.
For an example implementation see the Überauth Example application.
Depending on the configured URL you can initialize the request through:
/auth/facebook
Or with options:
/auth/facebook?scope=email,public_profile
By default the requested scope is "public_profile". Scope can be configured either explicitly as a scope
query value on the request path or in your configuration:
config :ueberauth, Ueberauth,
providers: [
facebook: {Ueberauth.Strategy.Facebook, [default_scope: "email,public_profile,user_friends"]}
]
Starting with Graph API version 2.4, Facebook has limited the default fields returned when fetching the user profile.
Fields can be explicitly requested using the profile_fields
option:
config :ueberauth, Ueberauth,
providers: [
facebook: {Ueberauth.Strategy.Facebook, [profile_fields: "name,email,first_name,last_name"]}
]
See Graph API Reference > User for full list of fields.
Please see LICENSE for licensing details.