EzAuth.Strategy behaviour (EzAuth v0.1.0)

Behaviour implemented by authentication strategies.

Summary

Types

meta()

result()

Callbacks

callback(conn, params)

request(conn, params)

Functions

slug(strategy)

supported_strategies()

Types

meta()

@type meta() :: %{
  id: atom(),
  name: String.t(),
  identity: atom(),
  kind: :credential | :passwordless | :social,
  callback_methods: [atom()]
}

result()

@type result() :: {:ok, Plug.Conn.t(), user :: struct()} | {:error, reason :: term()}

Callbacks

callback(conn, params)

@callback callback(conn :: Plug.Conn.t(), params :: map()) :: result()

request(conn, params)

@callback request(conn :: Plug.Conn.t(), params :: map()) :: result()