AccessPass v1.1.0 API Reference

This is the main Public api and out of the box all you will use. Includes everything you need for all your authentication needs.

Plug that checks for access-token in header and then checks if its expired or revoked. If it's not expired/revoked it adds the stored data from the token in meta. If it is then it returns 401 unauthorized and halts the plug by default. Can be changed. You can pass confirmed: true on the plug to only auth if the users email has been confirmed.

Plug that checks for access-token in header and then checks if its expired or revoked. If it's not expired/revoked it adds the stored data from the token in meta. If it is then it returns 401 unauthorized and halts the plug by default. Can be changed. You can pass any number of arguments in keyword list format to match against the users meta obj that is stored on registration. An example use case is for role based auth.

Routes provides a drop in macro to generate routes for a phoenix route file to handle the following endpoints

This Module provides you the ability to override AccessPass behavior Create a new module in your application and impliment any of the callbacks below to override default behavior. EX.