diff --git a/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx b/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx index 912ecf90e03..d41c0ecc3fa 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx @@ -11,13 +11,13 @@ import TabItem from '@theme/TabItem' Generates email links and OTPs to be sent via a custom email provider. ```js -const { data, error } = await supabase.auth.admin.generateLink( - 'email@example.com' - 'signup', - { - 'password': 'secret' - } -) +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'signup', + email: 'email@example.com', + options: { + password: 'secret', + }, +}) ``` ## Parameters @@ -133,23 +133,51 @@ No description provided. ## Examples -### Generate a signup link. +### Generate a signup link ```js -const { data, error } = await supabase.auth.admin.generateLink( - 'email@example.com' - 'signup', - { - 'password': 'secret' - } -) +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'signup', + email: 'email@example.com', + options: { + password: 'secret', + }, +}) ``` -### Generate an invite link. +### Generate an invite link ```js -const { data, error } = await supabase.auth.admin.generateLink( - 'email@example.com' - 'invite', -) +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'invite', + email: 'email@example.com', +}) +``` + +### Generate a magic link + +```js +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'magiclink', + email: 'email@example.com', +}) +``` + +### Generate a recovery link + +```js +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'recovery', + email: 'email@example.com', +}) +``` + +### Generate a link to change email addresses + +```js +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'email_change_current', + email: 'old.email@example.com', + newEmail: 'new.email@example.com', +}) ``` diff --git a/spec/supabase_js_v2_legacy.yml b/spec/supabase_js_v2_legacy.yml index 941bfb76299..25ee1c4430f 100644 --- a/spec/supabase_js_v2_legacy.yml +++ b/spec/supabase_js_v2_legacy.yml @@ -526,7 +526,7 @@ pages: email: 'email@example.com' }) ``` - - name: Generate an Magic link + - name: Generate a magic link isSpotlight: false js: | ```js @@ -535,7 +535,7 @@ pages: email: 'email@example.com' }) ``` - - name: Generate an recovery link + - name: Generate a recovery link isSpotlight: false js: | ```js @@ -544,7 +544,7 @@ pages: email: 'email@example.com' }) ``` - - name: Generate link to change email address + - name: Generate a link to change email addresses isSpotlight: false js: | ```js