API Reference permit_phoenix v#0.5.0

Phoenix, Plug and LiveView integrations integration for Permit.

Defines action names for your permissions schema, so that convenience functions are generated for them.

Configures and injects the authorization plug for Phoenix controllers.

Using this module, Permit authorization can be integrated with Phoenix LiveView at three key points

Hooks into the :mount and :handle_params lifecycles to authorize the current action. The current action is denoted by the :live_action assign (retrieved from the router), for example with the following route definition

Defines types for usage with Permit in the context of Phoenix applications.

Patches an existing Phoenix controller to use Permit authorization.

Patches an existing Phoenix LiveView to use Permit authorization by adding a resource_module/0 callback and @permit_action annotations on handle_event/3 clauses with recognized event names.

Installs Permit.Phoenix authorization into your project, creating an actions module and patching the web module to include LiveView authorization.