Assent v0.2.1

View Source Assent.Strategy.OIDC.Base behaviour (Assent v0.2.1)

OIDC OAuth 2.0 strategy base.

usage

 Usage 

defmodule MyApp.MyOIDCStrategy do
  use Assent.Strategy.OIDC.Base

  def default_config(_config) do
    [
      site: "https://oidc.example.com"
    ]
  end

  def normalize(_config, user), do: {:ok, user}
end

Link to this section Summary

Callbacks

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

Functions

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

Link to this section 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()}

Link to this section Functions

Link to this function

authorize_url(config, strategy)

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

callback(config, params, strategy)

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