API Reference permit v0.0.1

modules

Modules

Authorization facilities for the application.

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

Injects authorization plug (Permit.Plug), allowing to provide its options either directly in options of use, or as overridable functions.

This behaviour must be implemented by each module representing an authorization subject (usually this means an Ecto.Schema module for a User).

A live view module using the authorization mechanism should mix in the LiveViewAuthorization module

Conjunction of conditions

Conditions written as logical formula in disjunctive normal form Disjunction of dual clauses

Authorization plug for the web application.

This module is to be considered a private API of the authorization framework. It should not be directly used by application code, but rather by wrappers providing integration with e.g. Plug or LiveView.

Provides functions used for defining the application's permission set.