View Source AshAuthentication.AddOn.Confirmation (ash_authentication v4.2.5)
Confirmation support.
Sometimes when creating a new user, or changing a sensitive attribute (such as their email address) you may want to wait for the user to confirm by way of sending them a confirmation token to prove that it was really them that took the action.
In order to add confirmation to your resource, it must been the following minimum requirements:
- Have a primary key
- Have at least one attribute you wish to confirm
- Tokens must be enabled
Example
defmodule MyApp.Accounts.User do
use Ash.Resource,
extensions: [AshAuthentication],
domain: MyApp.Accounts
attributes do
uuid_primary_key :id
attribute :email, :ci_string, allow_nil?: false
end
authentication do
add_ons do
confirmation :confirm do
monitor_fields [:email]
sender MyApp.ConfirmationSender
end
end
strategies do
# ...
end
end
identities do
identity :email, [:email]
end
end
Attributes
A confirmed_at
attribute will be added to your resource if it's not already
present (see confirmed_at_field
in the DSL documentation).
Actions
By default confirmation will add an action which updates the confirmed_at
attribute as well as retrieving previously stored changes and applying them to
the resource.
If you wish to perform the confirm action directly from your code you can do
so via the AshAuthentication.Strategy
protocol.
Example
iex> strategy = Info.strategy!(Example.User, :confirm)
...> {:ok, user} = Strategy.action(strategy, :confirm, %{"confirm" => confirmation_token()})
...> user.confirmed_at >= one_second_ago()
true
Plugs
Confirmation provides a single endpoint for the :confirm
phase. If you wish
to interact with the plugs directly, you can do so via the
AshAuthentication.Strategy
protocol.
Example
iex> strategy = Info.strategy!(Example.User, :confirm)
...> conn = conn(:get, "/user/confirm", %{"confirm" => confirmation_token()})
...> conn = Strategy.plug(strategy, :confirm, conn)
...> {_conn, {:ok, user}} = Plug.Helpers.get_authentication_result(conn)
...> user.confirmed_at >= one_second_ago()
true
Summary
Functions
Generate a confirmation token for a changeset.
Callback implementation for AshAuthentication.Strategy.Custom.transform/2
.
Callback implementation for AshAuthentication.Strategy.Custom.verify/2
.
Types
@type t() :: %AshAuthentication.AddOn.Confirmation{ auto_confirm_actions: [atom()], confirm_action_name: atom(), confirm_on_create?: boolean(), confirm_on_update?: boolean(), confirmed_at_field: atom(), inhibit_updates?: boolean(), monitor_fields: [atom()], name: :confirm, prevent_hijacking?: boolean(), provider: :confirmation, resource: module(), sender: nil | {module(), keyword()}, strategy_module: module(), token_lifetime: hours :: pos_integer() }
Functions
@spec confirmation_token(t(), Ash.Changeset.t(), Ash.Resource.record()) :: {:ok, String.t()} | :error | {:error, any()}
Generate a confirmation token for a changeset.
This will generate a token with the "act"
claim set to the confirmation
action for the strategy, and the "chg"
claim will contain any changes.
Callback implementation for AshAuthentication.Strategy.Custom.transform/2
.
Callback implementation for AshAuthentication.Strategy.Custom.verify/2
.