HookSniff.Auth (hooksniff v1.1.1)

Authentication — register, login, 2FA, email verification, password reset.

Summary

Functions

Delete user account

Enable two-factor authentication

Export user data

Request password reset

Register a new user

Verify email address

Functions

delete_account(client)

@spec delete_account(HookSniff.t()) :: {:ok, map()} | {:error, term()}

Delete user account

enable_2fa(client, params)

@spec enable_2fa(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}

Enable two-factor authentication

export_data(client)

@spec export_data(HookSniff.t()) :: {:ok, map()} | {:error, term()}

Export user data

forgot_password(client, params)

@spec forgot_password(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}

Request password reset

login(client, params)

@spec login(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}

Log in

register(client, params)

@spec register(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}

Register a new user

verify_email(client)

@spec verify_email(HookSniff.t()) :: {:ok, map()} | {:error, term()}

Verify email address