ash_authentication/documentation/dsls/DSL:-AshAuthentication.Strategy.MagicLink.md

DSL: AshAuthentication.Strategy.MagicLink

Strategy for authentication using a magic link.

In order to use magic link authentication your resource needs to meet the following minimum requirements:

1. Have a primary key.
2. A uniquely constrained identity field (eg username or email)
3. Have tokens enabled.

There are other options documented in the DSL.

Example

defmodule MyApp.Accounts.User do
  use Ash.Resource,
    extensions: [AshAuthentication]

  attributes do
    uuid_primary_key :id
    attribute :email, :ci_string, allow_nil?: false
  end

  authentication do
    api MyApp.Accounts

    strategies do
      magic_link do
        identity_field :email
        sender fn user, token, _opts ->
          MyApp.Emails.deliver_magic_link(user, token)
        end
      end
    end
  end

  identities do
    identity :unique_email, [:email]
  end
end

Actions

By default the magic link strategy will automatically generate the request and sign-in actions for you, however you're free to define them yourself. If you do, then the action will be validated to ensure that all the needed configuration is present.

If you wish to work with the actions directly from your code you can do so via the AshAuthentication.Strategy protocol.

Examples

Requesting that a magic link token is sent for a user:

iex> strategy = Info.strategy!(Example.User, :magic_link)
...> user = build_user()
...> Strategy.action(strategy, :request, %{"username" => user.username})
:ok

Signing in using a magic link token:

...> {:ok, token} = MagicLink.request_token_for(strategy, user)
...> {:ok, signed_in_user} = Strategy.action(strategy, :sign_in, %{"token" => token})
...> signed_in_user.id == user
true

Plugs

The magic link strategy provides plug endpoints for both request and sign-in actions.

If you wish to work with the plugs directly, you can do so via the AshAuthentication.Strategy protocol.

Examples:

Dispatching to plugs directly:

iex> strategy = Info.strategy!(Example.User, :magic_link)
...> user = build_user()
...> conn = conn(:post, "/user/magic_link/request", %{"user" => %{"username" => user.username}})
...> conn = Strategy.plug(strategy, :request, conn)
...> {_conn, {:ok, nil}} = Plug.Helpers.get_authentication_result(conn)

...> {:ok, token} = MagicLink.request_token_for(strategy, user)
...> conn = conn(:get, "/user/magic_link", %{"token" => token})
...> conn = Strategy.plug(strategy, :sign_in, conn)
...> {_conn, {:ok, signed_in_user}} = Plug.Helpers.get_authentication_result(conn)
...> signed_in_user.id == user.id
true

DSL Documentation

Strategy for authenticating using local users with a magic link

• :identity_field (t:atom/0) - The name of the attribute which uniquely identifies the user.
  Usually something like username or email_address. The default value is :username.

• :token_lifetime - How long the sign in token is valid.
  If no unit is provided, then minutes is assumed. The default value is {10, :minutes}.

• :request_action_name (t:atom/0) - The name to use for the request action.
  If not present it will be generated by prepending the strategy name with request_.

• :single_use_token? (t:boolean/0) - Automatically revoke the token once it's been used for sign in. The default value is true.

• :sign_in_action_name (t:atom/0) - The name to use for the sign in action.
  If not present it will be generated by prepending the strategy name with sign_in_with_.

• :token_param_name (t:atom/0) - The name of the token parameter in the incoming sign-in request. The default value is :token.

• :sender - Required. How to send the magic link to the user.
  Allows you to glue sending of magic links to swoosh, ex_twilio or whatever notification system is appropriate for your application.
  Accepts a module, module and opts, or a function that takes a record, reset token and options.
  See AshAuthentication.Sender for more information.

authentication.strategies.magic_link

magic_link name \\ :magic_link

Strategy for authenticating using local users with a magic link

Options

Name	Type	Default	Docs
sender{: #authentication-strategies-magic_link-sender .spark-required}	(any, any, any -> any) | module		How to send the magic link to the user. Allows you to glue sending of magic links to swoosh, ex_twilio or whatever notification system is appropriate for your application. Accepts a module, module and opts, or a function that takes a record, reset token and options. See AshAuthentication.Sender for more information.
identity_field{: #authentication-strategies-magic_link-identity_field }	atom	:username	The name of the attribute which uniquely identifies the user. Usually something like username or email_address.
token_lifetime{: #authentication-strategies-magic_link-token_lifetime }	pos_integer | {pos_integer, :days | :hours | :minutes | :seconds}	{10, :minutes}	How long the sign in token is valid. If no unit is provided, then minutes is assumed.
request_action_name{: #authentication-strategies-magic_link-request_action_name }	atom		The name to use for the request action. If not present it will be generated by prepending the strategy name with request_.
single_use_token?{: #authentication-strategies-magic_link-single_use_token? }	boolean	true	Automatically revoke the token once it's been used for sign in.
sign_in_action_name{: #authentication-strategies-magic_link-sign_in_action_name }	atom		The name to use for the sign in action. If not present it will be generated by prepending the strategy name with sign_in_with_.
token_param_name{: #authentication-strategies-magic_link-token_param_name }	atom	:token	The name of the token parameter in the incoming sign-in request.

Introspection

Target: AshAuthentication.Strategy.MagicLink