View Source AshAuthentication.Phoenix.Plug (ash_authentication_phoenix v2.4.2)

Helper plugs mixed in to your router.

When you use AshAuthentication.Phoenix.Router this module is included, so that you can use these plugs in your pipelines.

Summary

Functions

load_from_bearer(conn, opts)

Attempt to retrieve actors from the Authorization header(s).

load_from_session(conn, opts)

Attempt to retrieve all actors from the connections' session.

revoke_bearer_tokens(conn, opts)

Revoke all token(s) in the Authorization header(s).

store_in_session(conn, actor)

Store the actor in the connections' session.

Functions

load_from_bearer(conn, opts)

@spec load_from_bearer(
  Plug.Conn.t(),
  keyword()
) :: Plug.Conn.t()

Attempt to retrieve actors from the Authorization header(s).

A wrapper around AshAuthentication.Plug.Helpers.retrieve_from_bearer/2 with the otp_app as extracted from the endpoint.

load_from_session(conn, opts)

@spec load_from_session(
  Plug.Conn.t(),
  keyword()
) :: Plug.Conn.t()

Attempt to retrieve all actors from the connections' session.

A wrapper around AshAuthentication.Plug.Helpers.retrieve_from_session/2 with the otp_app as extracted from the endpoint.

revoke_bearer_tokens(conn, opts)

@spec revoke_bearer_tokens(Plug.Conn.t(), any()) :: Plug.Conn.t()

Revoke all token(s) in the Authorization header(s).

A wrapper around AshAuthentication.Plug.Helpers.revoke_bearer_tokens/2 with the otp_app as extracted from the endpoint.

store_in_session(conn, actor)

@spec store_in_session(Plug.Conn.t(), Ash.Resource.record()) :: Plug.Conn.t()

Store the actor in the connections' session.