JavaScript: Generate an email link (original) (raw)

• Introduction
• Installing
• Initializing
• TypeScript support
• Database
• Fetch data
• Insert data
• Update data
• Upsert data
• Delete data
• Call a Postgres function
• Using filters
• Column is equal to a value
• Column is not equal to a value
• Column is greater than a value
• Column is greater than or equal to a value
• Column is less than a value
• Column is less than or equal to a value
• Column matches a pattern
• Column matches a case-insensitive pattern
• Column is a value
• Column is in an array
• Column contains every element in a value
• Contained by value
• Greater than a range
• Greater than or equal to a range
• Less than a range
• Less than or equal to a range
• Mutually exclusive to a range
• With a common element
• Match a string
• Match an associated value
• Don't match the filter
• Match at least one filter
• Match the filter
• Using modifiers
• Return data after inserting
• Order the results
• Limit the number of rows returned
• Limit the query to a range
• Set an abort signal
• Retrieve one row of data
• Retrieve zero or one row of data
• Retrieve as a CSV
• Override type of successful response
• Partially override or replace type of successful response
• Using explain
• Auth
• Overview
• Create a new user
• Listen to auth events
• Create an anonymous user
• Sign in a user
• Sign in with ID Token
• Sign in a user through OTP
• Sign in a user through OAuth
• Sign in a user through SSO
• Sign out a user
• Send a password reset request
• Verify and log in through OTP
• Retrieve a session
• Retrieve a new session
• Retrieve a user
• Update a user
• Retrieve identities linked to a user
• Link an identity to a user
• Unlink an identity from a user
• Send a password reauthentication nonce
• Resend an OTP
• Set the session data
• Exchange an auth code for a session
• Start auto-refresh session (non-browser)
• Stop auto-refresh session (non-browser)
• Auth MFA
• Enroll a factor
• Create a challenge
• Verify a challenge
• Create and verify a challenge
• Unenroll a factor
• Get Authenticator Assurance Level
• Auth Admin
• Retrieve a user
• List all users
• Create a user
• Delete a user
• Send an email invite link
• Generate an email link
• Update a user
• Delete a factor for a user
• Edge Functions
• Invokes a Supabase Edge Function.
• Realtime
• Subscribe to channel
• Unsubscribe from a channel
• Unsubscribe from all channels
• Retrieve all channels
• Broadcast a message
• Storage
• Create a bucket
• Retrieve a bucket
• List all buckets
• Update a bucket
• Delete a bucket
• Empty a bucket
• Upload a file
• Download a file
• List all files in a bucket
• Replace an existing file
• Move an existing file
• Copy an existing file
• Delete files in a bucket
• Create a signed URL
• Create signed URLs
• Create signed upload URL
• Upload to a signed URL
• Retrieve public URL
• Misc
• Release Notes

Generates email links and OTPs to be sent via a custom email provider.

• The following types can be passed into generateLink(): signup, magiclink, invite, recovery, email_change_current, email_change_new, phone_change.
• generateLink() only generates the email link for email_change_email if the Secure email change is enabled in your project's email auth provider settings.
• generateLink() handles the creation of the user for signup, invite and magiclink.

Parameters

• params

(Required)
undefined

Examples

Generate a signup link

const { data, error } = await supabase.auth.admin.generateLink({
  type: 'signup',
  email: 'email@example.com',
  password: 'secret'
})

Generate an invite link

const { data, error } = await supabase.auth.admin.generateLink({
  type: 'invite',
  email: 'email@example.com'
})

Generate a magic link

const { data, error } = await supabase.auth.admin.generateLink({
  type: 'magiclink',
  email: 'email@example.com'
})

Generate a recovery link

const { data, error } = await supabase.auth.admin.generateLink({
  type: 'recovery',
  email: 'email@example.com'
})

Generate links to change current email address

// generate an email change link to be sent to the current email address
const { data, error } = await supabase.auth.admin.generateLink({
  type: 'email_change_current',
  email: 'current.email@example.com',
  newEmail: 'new.email@example.com'
})

// generate an email change link to be sent to the new email address
const { data, error } = await supabase.auth.admin.generateLink({
  type: 'email_change_new',
  email: 'current.email@example.com',
  newEmail: 'new.email@example.com'
})