View Source Assent.Strategy.OAuth2.Base behaviour (Assent v0.2.9)

OAuth 2.0 strategy base.

Usage 

defmodule MyApp.MyOAuth2Strategy do
  use Assent.Strategy.OAuth2.Base

  def default_config(_config) do
    [
      base_url: "https://api.example.com",
      user_url: "/authorization.json"
    ]
  end

  @impl true
  def normalize(_config, user) do
    {:ok,
      # Conformed to https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.5.1
      %{
        "sub"   => user["id"],
        "name"  => user["name"],
        "email" => user["email"]
      # },
      # # Provider specific data not part of the standard claims spec
      # %{
      #  "https://example.com/bio" => user["bio"]
      }
    }
  end
end

Summary

Callbacks

default_config(t)
fetch_user(t, map)
normalize(t, map)

Functions

authorize_url(config, strategy)
callback(config, params, strategy)

Callbacks

Link to this callback

default_config(t)

View Source 
@callback default_config(Keyword.t()) :: Keyword.t()
Link to this callback

fetch_user(t, map)

View Source 
@callback fetch_user(Keyword.t(), map()) :: {:ok, map()} | {:error, term()}
Link to this callback

normalize(t, map)

View Source 
@callback normalize(Keyword.t(), map()) ::
  {:ok, map()} | {:ok, map(), map()} | {:error, term()}

Functions

Link to this function

authorize_url(config, strategy)

View Source 
@spec authorize_url(Keyword.t(), module()) ::
  {:ok, %{session_params: %{state: binary()}, url: binary()}}
Link to this function

callback(config, params, strategy)

View Source 
@spec callback(Keyword.t(), map(), module()) ::
  {:ok, %{user: map(), token: map()}} | {:error, term()}