Überauth Discord
Discord OAuth2 strategy for Überauth.
For additional documentation on Discord's OAuth implementation see discord-oauth2-example.
Installation
Setup your application at Discord Developers.
Add
:ueberauth_discord
to your list of dependencies inmix.exs
:def deps do [{:ueberauth_discord, "~> 0.6"}] end
Add the strategy to your applications:
def application do [applications: [:ueberauth_discord]] end
Add Discord to your Überauth configuration:
config :ueberauth, Ueberauth, providers: [ discord: {Ueberauth.Strategy.Discord, []} ]
Update your provider configuration:
config :ueberauth, Ueberauth.Strategy.Discord.OAuth, client_id: System.get_env("DISCORD_CLIENT_ID"), client_secret: System.get_env("DISCORD_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
And make sure to set the correct redirect URI(s) in your Discord application to wire up the callback.
Your controller needs to implement callbacks to deal with
Ueberauth.Auth
andUeberauth.Failure
responses.
For an example implementation see the Überauth Example application.
Calling
Depending on the configured url you can initialize the request through:
/auth/discord
Or with options:
/auth/discord?scope=identify%20email&prompt=none&permissions=452987952
By default the requested scope is "identify". Scope can be configured either explicitly as a scope
query value on the request path or in your configuration:
config :ueberauth, Ueberauth,
providers: [
discord: {Ueberauth.Strategy.Discord, [default_scope: "identify email connections guilds"]}
]
Additionally you can now specify the prompt
and permissions
params to pass to Discord:
config :ueberauth, Ueberauth,
providers: [
discord: {Ueberauth.Strategy.Discord, [
default_scope: "identify email connections guilds",
prompt: "none",
permissions: 452987952
]}
]
License
Please see LICENSE for licensing details.