Fast.Auth behaviour (Fast v0.11.0)

Summary

Types

login_method()

Callbacks

handle_login_failure(user, method, context)

handle_login_success(user, method, context)

Available features

verify_login_allowed(user, method, context)

Functions

ensure_fields_present!(atom, schema)

ensure_valid_features!(module, features)

raise_invalid_features!(module, invalid_features, unused_features)

raise_missing_fields!(feature, schema, missing_fields)

Types

login_method()

@type login_method() :: :password | :magic_link | :saml_sso

Callbacks

handle_login_failure(user, method, context)

(optional)

@callback handle_login_failure(user :: any(), method :: login_method(), context :: map()) ::
  any()

handle_login_success(user, method, context)

(optional)

@callback handle_login_success(user :: any(), method :: login_method(), context :: map()) ::
  any()

Available features:

:passwords
:confirmable
:invitable
:magic_links
:saml_sso
:login_attempt_locking
?

Opts:

:schema - The user account schema
:features - A subset of features.

verify_login_allowed(user, method, context)

(optional)

@callback verify_login_allowed(user :: any(), method :: login_method(), context :: map()) ::
  :ok | {:error, any()}

Functions

ensure_fields_present!(atom, schema)

ensure_valid_features!(module, features)

raise_invalid_features!(module, invalid_features, unused_features)

raise_missing_fields!(feature, schema, missing_fields)