Sigra.Admin.Users.Query (Sigra v0.2.3)

Copy Markdown View Source

Canonical query contract for the admin user list surface.

Summary

Types

row()

Functions

list_users(config, admin_scope, params \\ %{})
normalize_params(params)
summary_counts(config, admin_scope)

Types

row()

@type row() :: %{
  user: struct(),
  display_name: String.t() | nil,
  last_active_at: DateTime.t() | nil,
  has_mfa: boolean(),
  passkey_count: non_neg_integer(),
  organization_count: non_neg_integer(),
  organization_summary: String.t(),
  extra_badges: list(),
  extra_columns: list()
}

Functions

list_users(config, admin_scope, params \\ %{})

@spec list_users(map(), Sigra.Admin.Scope.t(), map() | keyword() | nil) ::
  {:ok, {[row()], Flop.Meta.t(), map()}} | {:error, Flop.Meta.t()}

normalize_params(params)

@spec normalize_params(map() | keyword() | nil) ::
  {:ok, map()} | {:error, Flop.Meta.t()}

summary_counts(config, admin_scope)

@spec summary_counts(map(), Sigra.Admin.Scope.t()) :: map()