Pow v0.1.0-alpha.6 Pow.Plug View Source

Authorization methods for Plug.

Link to this section Summary

Functions

Assign an authenticated user to the connection

Authenticates a user

Creates a changeset from the current authenticated user

Clears the user authentication from the session

Creates a new user

Get the current authenticated user

Deletes the current authenticated user

Fetch configuration from the private key in the connection

Put the provided config as a private key in the connection

Updates the current authenticated user

Link to this section Functions

Link to this function assign_current_user(conn, user, config) View Source
assign_current_user(Plug.Conn.t(), any(), Pow.Config.t()) :: Plug.Conn.t()

Assign an authenticated user to the connection.

Link to this function authenticate_user(conn, params) View Source
authenticate_user(Plug.Conn.t(), map()) ::
  {:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()} | no_return()

Authenticates a user.

If successful, a new session will be created.

Link to this function change_user(conn, params \\ %{}) View Source
change_user(Plug.Conn.t(), map()) :: map()

Creates a changeset from the current authenticated user.

Link to this function clear_authenticated_user(conn) View Source
clear_authenticated_user(Plug.Conn.t()) :: {:ok, Plug.Conn.t()} | no_return()

Clears the user authentication from the session.

Link to this function create_user(conn, params) View Source
create_user(Plug.Conn.t(), map()) ::
  {:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()} | no_return()

Creates a new user.

If successful, a new session will be created.

Link to this function current_user(conn) View Source
current_user(Plug.Conn.t()) :: map() | nil | no_return()
Link to this function current_user(map, config) View Source
current_user(Plug.Conn.t(), Pow.Config.t()) :: map() | nil

Get the current authenticated user.

Link to this function delete_user(conn) View Source
delete_user(Plug.Conn.t()) ::
  {:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()} | no_return()

Deletes the current authenticated user.

If successful, the user authentication will be cleared from the session.

Fetch configuration from the private key in the connection.

It’ll raise an error if configuration hasn’t been set as a private key.

Link to this function put_config(conn, config) View Source
put_config(Plug.Conn.t(), Pow.Config.t()) :: Plug.Conn.t()

Put the provided config as a private key in the connection.

Link to this function update_user(conn, params) View Source
update_user(Plug.Conn.t(), map()) ::
  {:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()} | no_return()

Updates the current authenticated user.

If successful, a new session will be created.