Ueberauth IcyNet v0.0.1 Ueberauth.Strategy.IcyNet View Source
Provides an Ueberauth strategy for authenticating with Icy Network.
Setup
Obtain a Client ID and Secret from Icy Network.
Include the provider in your configuration for Ueberauth
config :ueberauth, Ueberauth,
providers: [
icynet: { Ueberauth.Strategy.IcyNet, [] }
]
Then include the configuration for icynet.
config :ueberauth, Ueberauth.Strategy.IcyNet.OAuth,
client_id: System.get_env("ICYNET_CLIENT_ID"),
client_secret: System.get_env("ICYNET_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 uid_field
config :ueberauth, Ueberauth,
providers: [
icynet: { Ueberauth.Strategy.IcyNet, [uid_field: :email] }
]
Default is :id
To set the default 'scopes' (permissions):
config :ueberauth, Ueberauth,
providers: [
icynet: { Ueberauth.Strategy.IcyNet, [default_scope: "email,image"] }
]
Default is empty ("") which "Grants read-only access to public information (includes public user profile info, public repository info, and gists)"
Link to this section Summary
Functions
Includes the credentials from the IcyNet response.
Stores the raw information (including the token) obtained from the IcyNet callback.
Cleans up the private area of the connection used for passing the raw IcyNet response around during the callback.
Handles the initial redirect to the icynet authentication page.
Fetches the fields to populate the info section of the Ueberauth.Auth
struct.
Fetches the uid field from the IcyNet response. This defaults to the option uid_field
which in-turn defaults to id
Link to this section Functions
Includes the credentials from the IcyNet response.
Stores the raw information (including the token) obtained from the IcyNet callback.
Cleans up the private area of the connection used for passing the raw IcyNet response around during the callback.
Handles the initial redirect to the icynet authentication page.
To customize the scope (permissions) that are requested by icynet include them as part of your url:
"/auth/icynet?scope=email,image,privilege"
You can also include a state
param that icynet will return to you.
Fetches the fields to populate the info section of the Ueberauth.Auth
struct.
Fetches the uid field from the IcyNet response. This defaults to the option uid_field
which in-turn defaults to id