Pleroma v1.1.9-10-g42f76306+dev Pleroma.Web.Auth.Authenticator behaviour View Source

Link to this section Summary

Gets user by nickname or email for auth.

fetch_credentials(Plug.Conn.t() | map()) ::
  {:ok, {name :: any(), password :: any()}} | {:error, :invalid_credentials}

fetch_user(String.t()) :: Pleroma.User.t() | nil

Gets user by nickname or email for auth.

auth_template() :: String.t() | nil

create_from_registration(Plug.Conn.t(), Pleroma.Registration.t()) ::
  {:ok, Pleroma.User.t()} | {:error, any()}

get_registration(Plug.Conn.t()) ::
  {:ok, Pleroma.Registration.t()} | {:error, any()}

get_user(Plug.Conn.t()) :: {:ok, Pleroma.User.t()} | {:error, any()}

handle_error(Plug.Conn.t(), any()) :: any()

oauth_consumer_template() :: String.t() | nil