Packages

authable

0.6.6
0.11.0 0.10.0 0.9.2 0.9.1 0.9.0 0.8.0 0.7.0 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.1 0.5.0 0.4.0 0.3.2 0.3.1 0.3.0 0.2.2 0.2.1 0.2.0 0.1.0

OAuth2 Provider implementation modules and helpers using `ecto` and `postgress` for any `elixir` application.

HexDocs

Current section

Files

Jump to
Readme
24 Versions
6 Dependencies
Dependants
Files
Activity
authable lib authable authentication.ex
Raw

lib/authable/authentication.ex 

defmodule Authable.Authentication do

  @moduledoc """

  A behaviour for all authentications modules called by other authable modules.



  ## Creating a custom module



  If you are going to create a custom authentication module, then you need to

  implement following function:

    * `authenticate`

  """



  @doc """

  Finds and returns Resource Owner(User) struct using a param(param can be any

  type).



  This function returns a `{:ok, Authable.Model.User struct}` or

  `{:error, Map, :http_status_code}`.

  """

  @callback authenticate(any, List) :: {:ok, Application.get_env(:authable,

    :resource_owner)} | {:error, Map, Atom}

end