API Reference ash_authentication_phoenix v#3.0.0-rc.6
Modules
Welcome to AshAuthentication.Pheonix.
Generates a sign-in button for Apple.
Renders a very simple banner at the top of the sign-in component.
Renders a confirmation button.
Generates a default confirmation form.
Function components for dealing with form input during password authentication.
Renders a sign-in button per database-stored OIDC connection.
Renders the Phoenix flash messages set by Ash Authentication Phoenix.
Helpers which are commonly needed inside the various components.
A horizontal rule with text.
Generates a sign-in for for a resource using the "Magic link" strategy.
Generates a default magic sign in form.
Function components for dealing with form input during magic link sign in.
Renders a magic sign in button.
Generates a sign-in button for OAuth2.
Generates a sign-in form for the OTP strategy.
Function components for dealing with form input during OTP authentication.
Generates the form for requesting an OTP code (step one of the OTP flow).
Generates the form for verifying an OTP code (step two of the OTP flow).
Generates sign in, registration and reset forms for a resource.
Function components for dealing with form input during password authentication.
Generates a default registration form.
Generates a default password reset form.
Generates a default sign in form.
Generates and displays recovery codes for the authenticated user.
Function components for recovery code form inputs.
Generates a verification form for recovery code authentication.
Renders a password-reset form.
Generates a default password reset form.
Renders sign in mark-up for an authenticated resource.
Renders a sign-out confirmation form.
Generates sign in and setup forms for TOTP authentication.
Function components for dealing with form input during TOTP authentication.
Generates a setup form for TOTP authentication with QR code display.
Generates a sign in form for TOTP authentication.
Generates a verification form for TOTP two-factor authentication.
Generates sign in and registration forms for WebAuthn/Passkey authentication.
Authentication form for WebAuthn.
Function components for WebAuthn form inputs.
Credential management panel for authenticated users.
Registration form for WebAuthn.
Detects WebAuthn browser support via a JS hook.
Drives the WebAuthn second-factor ceremony.
A generic, white-label confirmation page.
The authentication controller generator.
Ensures that any loaded users which are present in a conn's assigns are also present in a live view socket's assigns.
A LiveView on_mount hook that enforces recovery code configuration.
A LiveView on_mount hook that enforces TOTP two-factor authentication.
A LiveView on_mount hook that enforces WebAuthn second-factor verification
for live routes.
A generic, white-label confirmation page.
Behaviour for overriding component styles and attributes in your application.
This is the daisyUI overrides for our component UI. Copied from the AshAuthentication.Phoenix.Overrides.Default module with tweaks.
This is the default overrides for our component UI.
Override introspection.
Auto generates documentation and helpers for components.
Helper plugs mixed in to your router.
A plug that enforces recovery code configuration for routes.
A plug that enforces TOTP two-factor authentication for routes.
A plug that enforces WebAuthn second-factor verification for routes.
A generic, white-label page for generating and displaying recovery codes.
Helper functions for working with recovery code authentication.
A generic, white-label recovery code verification page.
A generic, white-label password reset page.
Phoenix route generation for AshAuthentication.
A generic, white-label sign-in page.
A generic, white-label sign-out confirmation page.
This module contains pages rendered by AuthController.
Gettext stub, referenced in AshAuthentication.Phoenix.Test.Router
Test helpers for WebAuthn component tests.
An Ash notifier that broadcasts LiveView disconnect messages when tokens are revoked.
Helper functions for working with TOTP two-factor authentication.
A generic, white-label TOTP setup page for configuring two-factor authentication.
A generic, white-label TOTP verification page for two-factor authentication.
Utility functions for sending and receiving flash messages.
Helpers shared between the WebAuthn LiveView components.
Helper functions for working with WebAuthn second-factor authentication.
A generic, white-label WebAuthn passkey setup page for second-factor flows.
A generic, white-label WebAuthn second-factor verification page.
Mix Tasks
Prints all routes pertaining to AshAuthenticationPhoenix for the default or a given router.
Adds Phoenix integration for the email confirmation add-on
Adds a strategy to your user resource with Phoenix integration
Adds Phoenix integration for the magic link authentication strategy
Adds Phoenix integration for the OTP authentication strategy
Adds Phoenix integration for the password authentication strategy
Adds Phoenix integration for the recovery code authentication strategy
Adds Phoenix integration for the TOTP authentication strategy
Adds Phoenix integration for the WebAuthn authentication strategy
Installs AshAuthenticationPhoenix. Invoke with mix igniter.install ash_authentication_phoenix
Ensures Phoenix authentication infrastructure (routes, controller, sign-in page) exists