PhoenixKit.Users.MagicLinkRegistration (phoenix_kit v2.7.0)

Copy Markdown View Source

Two-step user registration via Magic Link email.

Flow:

  1. User enters email
  2. Receives magic link via email
  3. Clicks link to complete registration with profile details

Summary

Functions

cleanup_expired_tokens()

Cleans up expired registration tokens.

complete_registration(token, attrs, ip_address \\ nil)

Completes user registration using a magic link token.

delete_registration_token(token)

Deletes a registration token.

get_expiry_minutes()
registration_link_url(token)

Generates a registration magic link URL.

send_registration_link(email, ip_address \\ nil)

Sends a registration magic link to the specified email address.

verify_registration_token(token)

Verifies a magic link registration token.

Functions

cleanup_expired_tokens()

Cleans up expired registration tokens.

complete_registration(token, attrs, ip_address \\ nil)

Completes user registration using a magic link token.

delete_registration_token(token)

Deletes a registration token.

get_expiry_minutes()

send_registration_link(email, ip_address \\ nil)

Sends a registration magic link to the specified email address.

Rate-limited on the same buckets as password registration — this is a registration entry point, and it was the one public auth endpoint with no limit at all. ip_address is optional only because callers without peer data exist; pass it whenever you have it, or a single client can spread its attempts across unlimited addresses.

verify_registration_token(token)

Verifies a magic link registration token.