HookSniff.Auth (hooksniff v1.2.0)
Authentication — register, login, logout, 2FA, password, GDPR.
Summary
Functions
Change password
Confirm 2FA setup
Delete user account
Disable 2FA
Enable two-factor authentication
Export user data (GDPR)
Forgot password
Get 2FA status
Log in
Log out
Get current user
Register a new user
Resend verification email
Reset password
Update profile
Verify email
Functions
@spec change_password(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Change password
@spec confirm_2fa(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Confirm 2FA setup
@spec delete_account(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Delete user account
@spec disable_2fa(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Disable 2FA
@spec enable_2fa(HookSniff.t()) :: {:ok, map()} | {:error, term()}
Enable two-factor authentication
@spec export_data(HookSniff.t()) :: {:ok, map()} | {:error, term()}
Export user data (GDPR)
@spec forgot_password(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Forgot password
@spec get_2fa_status(HookSniff.t()) :: {:ok, map()} | {:error, term()}
Get 2FA status
@spec login(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Log in
@spec logout(HookSniff.t()) :: {:ok, map()} | {:error, term()}
Log out
@spec me(HookSniff.t()) :: {:ok, map()} | {:error, term()}
Get current user
@spec register(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Register a new user
@spec resend_verification(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Resend verification email
@spec reset_password(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Reset password
@spec update_profile(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Update profile
@spec verify_email(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}
Verify email