View Source Plausible.Auth (Plausible v0.0.1)

Functions for user authentication context.

Summary

Types

rate_limit_type()

Functions

check_password(user, password)

create_api_key(user, name, key)

create_user(name, email, pwd)

delete_api_key(user, id)

delete_user(user)

enterprise_configured?(user)

find_api_key(raw_key)

find_user_by(opts)

get_user_by(opts)

has_active_sites?(user, roles \\ [:owner, :admin, :viewer])

is_super_admin?(user_id)

rate_limit(limit_type, key)

rate_limits()

user_owns_sites?(user)

Types

rate_limit_type()

@type rate_limit_type() :: :email_change_user | :login_user | :login_ip

Functions

check_password(user, password)

@spec check_password(Plausible.Auth.User.t(), String.t()) ::
  :ok | {:error, :wrong_password}

create_api_key(user, name, key)

@spec create_api_key(Plausible.Auth.User.t(), String.t(), String.t()) ::
  {:ok, Plausible.Auth.ApiKey.t()}
  | {:error, Ecto.Changeset.t() | :upgrade_required}

create_user(name, email, pwd)

delete_api_key(user, id)

@spec delete_api_key(Plausible.Auth.User.t(), integer()) :: :ok | {:error, :not_found}

delete_user(user)

enterprise_configured?(user)

find_api_key(raw_key)

@spec find_api_key(String.t()) ::
  {:ok, Plausible.Auth.ApiKey.t()} | {:error, :invalid_api_key}

find_user_by(opts)

@spec find_user_by(Keyword.t()) :: Plausible.Auth.User.t() | nil

get_user_by(opts)

@spec get_user_by(Keyword.t()) ::
  {:ok, Plausible.Auth.User.t()} | {:error, :user_not_found}

has_active_sites?(user, roles \\ [:owner, :admin, :viewer])

is_super_admin?(user_id)

rate_limit(limit_type, key)

@spec rate_limit(rate_limit_type(), Plausible.Auth.User.t() | Plug.Conn.t()) ::
  :ok | {:error, {:rate_limit, rate_limit_type()}}

rate_limits()

@spec rate_limits() :: map()