Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ueberauth/ueberauth_Facebook
Facebook OAuth2 Strategy for Überauth.
https://github.com/ueberauth/ueberauth_Facebook
facebook oauth oauth2 strategy ueberauth ueberauth-strategies
Last synced: 3 days ago
JSON representation
Facebook OAuth2 Strategy for Überauth.
- Host: GitHub
- URL: https://github.com/ueberauth/ueberauth_Facebook
- Owner: ueberauth
- License: mit
- Created: 2015-11-15T20:13:58.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-12T13:59:59.000Z (about 1 year ago)
- Last Synced: 2024-10-08T00:27:58.087Z (27 days ago)
- Topics: facebook, oauth, oauth2, strategy, ueberauth, ueberauth-strategies
- Language: Elixir
- Homepage:
- Size: 85 KB
- Stars: 77
- Watchers: 8
- Forks: 64
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Facebook OAuth2 Strategy for Ãberauth. (Authentication)
- awesome-elixir - ueberauth_facebook - Facebook OAuth2 Strategy for Überauth. (Authentication)
- fucking-awesome-elixir - ueberauth_facebook - Facebook OAuth2 Strategy for Überauth. (Authentication)
README
# Überauth Facebook
[](https://travis-ci.org/ueberauth/ueberauth_facebook)
[](https://hex.pm/packages/ueberauth_facebook)
[](https://hexdocs.pm/ueberauth_facebook/)
[](https://hex.pm/packages/ueberauth_facebook)
[](https://github.com/ueberauth/ueberauth_facebook/blob/master/LICENSE)
[](https://github.com/ueberauth/ueberauth_facebook/commits/master)
> Facebook OAuth2 strategy for Überauth.
## Installation
1. Setup your application at [Facebook Developers](https://developers.facebook.com).
1. Add `:ueberauth_facebook` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ueberauth_facebook, "~> 0.8"}
]
end
```
1. Add the strategy to your applications:
```elixir
def application do
[
applications: [:ueberauth_facebook]
]
end
```
1. Add Facebook to your Überauth configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
facebook: {Ueberauth.Strategy.Facebook, []}
]
```
1. Update your provider configuration:
```elixir
config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
client_id: System.get_env("FACEBOOK_CLIENT_ID"),
client_secret: System.get_env("FACEBOOK_CLIENT_SECRET")
```
1. Include the Überauth plug in your controller:
```elixir
defmodule MyApp.AuthController do
use MyApp.Web, :controller
plug Ueberauth
...
end
```
1. Create the request and callback routes if you haven't already:
```elixir
scope "/auth", MyApp do
pipe_through :browser
get "/:provider", AuthController, :request
get "/:provider/callback", AuthController, :callback
end
```
1. Your controller needs to implement callbacks to deal with `Ueberauth.Auth` and `Ueberauth.Failure` responses.
For an example implementation see the [Überauth Example](https://github.com/ueberauth/ueberauth_example) application.
## Calling
Depending on the configured URL you can initialize the request through:
/auth/facebook
Or with options (`auth_type`, `scope`, `locale`, `display`):
/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:
```elixir
config :ueberauth, Ueberauth,
providers: [
facebook: {Ueberauth.Strategy.Facebook, [default_scope: "email,public_profile,user_friends"]}
]
```
Additionally you can now specify the `display` param to pass to Facebook:
```elixir
config :ueberauth, Ueberauth,
providers: [
facebook: {Ueberauth.Strategy.Facebook, [
default_scope: "email,public_profile,user_friends",
display: "popup"
]}
]
```
`display` can be the following values: `page` (default), `async`, `iframe`, `popup`, `touch`, `wap`
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:
```elixir
config :ueberauth, Ueberauth,
providers: [
facebook: {Ueberauth.Strategy.Facebook, [profile_fields: "name,email,first_name,last_name"]}
]
```
See [Graph API Reference > User](https://developers.facebook.com/docs/graph-api/reference/user) for full list of fields.
## Copyright and License
Copyright (c) 2015 Sean Callan
Released under the MIT License, which can be found in the repository in [LICENSE](./LICENSE).