dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 17:35:10 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: update auth docs for supabase-js v2 (#8648)

Browse Source 
* docs: cleanup auth docs

* docs: update auth docs

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

Co-authored-by: dng <danny@supabase.io>

* Update spec/supabase_js_v2_legacy.yml

* update auth docs

* add supabase auth admin api overview page

* resolve PR comments

* resolve PR comments

* update auth docs with latest tsdocs

Co-authored-by: dng <danny@supabase.io>
This commit is contained in:
Kang Minganddng authored and GitHub committed 2022-08-30 13:40:08 +08:00
1 parent 98b518843d
commit 2812617d0f
27 files changed
+21602 -16847
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/reference/_supabase_js/generated/auth-admin-createuser.mdx
+15 -35
View File
@@ -58,11 +58,11 @@ No description provided.
</h4>
<div class="method-list-item-description">
A custom data object for app_metadata that.
A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.
Only a service role can modify.
Can be any JSON that includes app-specific info, such as identity providers, roles, and other
The `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other
access control information.
</div>
@@ -83,7 +83,9 @@ access control information.
</h4>
<div class="method-list-item-description">
A custom data object for user_metadata that a user can modify. Can be any JSON.
A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
The `data` should be a JSON object that includes user-specific info, such as their first and last name.
</div>
@@ -109,26 +111,6 @@ The user's email.
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
email_change_token
</span>
<span className="method-list-item-label-badge false">
optional
</span>
<span className="method-list-item-validation">
<code>string</code>
</span>
</h4>
<div class="method-list-item-description">
An email change token.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
@@ -143,7 +125,7 @@ An email change token.
</h4>
<div class="method-list-item-description">
Sets if a user has confirmed their email address.
Confirms the user's email address if set to true.
Only a service role can modify.
@@ -205,7 +187,7 @@ The user's phone.
</h4>
<div class="method-list-item-description">
Sets if a user has confirmed their phone number.
Confirms the user's phone number if set to true.
Only a service role can modify.
@@ -227,13 +209,13 @@ Only a service role can modify.
</h4>
<div class="method-list-item-description">
A custom data object for user_metadata.
Can be any JSON.
A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
Only a service role can modify.
Note: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,
The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.
Note: When using the GoTrueAdminApi and wanting to modify a user's metadata,
this attribute is used instead of UserAttributes data.
</div>
@@ -248,13 +230,11 @@ this attribute is used instead of UserAttributes data.
## Notes
- Requires a `service_role` key.
- This function should be called on a server. Never expose your `service_role` key in the browser.
- If you do not provide the `email_confirm` and `phone_confirm` options to this function, both will default to false.
- To confirm the user's email address or phone number, set `email_confirm` or `phone_confirm` to true. Both arguments default to false.
## Examples
### Create a new user.
### Create a new user with custom user metadata
```js
const { data, error } = await supabase.auth.admin.createUser({
@@ -264,7 +244,7 @@ const { data, error } = await supabase.auth.admin.createUser({
})
```
### Auto-confirm email.
### Auto-confirm the user's email
```js
const { data, error } = await supabase.auth.admin.createUser({
@@ -273,7 +253,7 @@ const { data, error } = await supabase.auth.admin.createUser({
})
```
### Auto-confirm phone.
### Auto-confirm the user's phone number
```js
const { data, error } = await supabase.auth.admin.createUser({
apps/reference/_supabase_js/generated/auth-admin-deleteuser.mdx
+4 -5
View File
@@ -23,7 +23,7 @@ const { data, error } = await supabase.auth.admin.deleteUser(
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
uid
id
</span>
<span className="method-list-item-label-badge required">
required
@@ -34,7 +34,7 @@ const { data, error } = await supabase.auth.admin.deleteUser(
</h4>
<div class="method-list-item-description">
The user uid you want to remove.
The user id you want to remove.
This function should only be called on a server. Never expose your `service_role` key in the browser.
@@ -46,12 +46,11 @@ This function should only be called on a server. Never expose your `service_role
## Notes
- Requires a `service_role` key.
- This function should be called on a server. Never expose your `service_role` key in the browser.
- The `deleteUser()` method requires the user's ID, which maps to the `auth.users.id` column.
## Examples
### Remove a user completely.
### Removes a user
```js
const { data, error } = await supabase.auth.admin.deleteUser(
apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx
+37 -187
View File
@@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Generates links to be sent via email or other.
Generates email links and OTPs to be sent via a custom email provider.
```js
const { data, error } = await supabase.auth.admin.generateLink(
@@ -27,178 +27,13 @@ const { data, error } = await supabase.auth.admin.generateLink(
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
GenerateLinkType
GenerateLinkParams
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>signup</code> | <code>invite</code> | <code>magiclink</code> | <code>recovery</code> | <code>email_change_current</code> | <code>email_change_new</code>
</span>
</h4>
<div class="method-list-item-description">
The link type
</div>
<ul className="method-list-group">
<h5 class="method-list-title method-list-title-isChild expanded">Properties</h5>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
email_change_new
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
literal
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
email_change_current
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
literal
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
recovery
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
literal
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
magiclink
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
literal
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
invite
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
literal
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
signup
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
literal
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
</li>
</ul>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
email
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>string</code>
</span>
</h4>
<div class="method-list-item-description">
The user's email.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
options
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>object</code>
<code>GenerateSignupLinkParams</code> | <code>GenerateInviteOrMagiclinkParams</code> | <code>GenerateRecoveryLinkParams</code> | <code>GenerateEmailChangeLinkParams</code>
</span>
</h4>
<div class="method-list-item-description">
@@ -213,10 +48,10 @@ No description provided.
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
data
GenerateSignupLinkParams
</span>
<span className="method-list-item-label-badge false">
optional
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>object</code>
@@ -224,7 +59,7 @@ No description provided.
</h4>
<div class="method-list-item-description">
Optional user metadata. For signup only.
No description provided.
</div>
@@ -233,18 +68,18 @@ Optional user metadata. For signup only.
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
password
GenerateRecoveryLinkParams
</span>
<span className="method-list-item-label-badge false">
optional
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>string</code>
<code>object</code>
</span>
</h4>
<div class="method-list-item-description">
User password. For signup only.
No description provided.
</div>
@@ -253,18 +88,38 @@ User password. For signup only.
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
redirectTo
GenerateInviteOrMagiclinkParams
</span>
<span className="method-list-item-label-badge false">
optional
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>string</code>
<code>object</code>
</span>
</h4>
<div class="method-list-item-description">
The redirect url which should be appended to the generated link
No description provided.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
GenerateEmailChangeLinkParams
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>object</code>
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
@@ -276,11 +131,6 @@ The redirect url which should be appended to the generated link
</ul>
## Notes
- Requires a `service_role` key.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
## Examples
### Generate a signup link.
apps/reference/_supabase_js/generated/auth-admin-getuserbyid.mdx
+4 -5
View File
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'
Get user by id.
```js
const { user, error } = await supabase.auth.admin.getUserById(1)
const { data, error } = await supabase.auth.admin.getUserById(1)
```
## Parameters
@@ -44,14 +44,13 @@ This function should only be called on a server. Never expose your `service_role
## Notes
- Fetches the user object from the database instead of local storage.
- Note that user() fetches the user object from local storage which might not be the most updated.
- Requires the user's access_token.
- Fetches the user object from the database based on the user's id.
- The `getUserById()` method requires the user's id which maps to the `auth.users.id` column.
## Examples
### Fetch the user object using the access_token jwt.
```js
const { user, error } = await supabase.auth.admin.getUserById(1)
const { data, error } = await supabase.auth.admin.getUserById(1)
```
apps/reference/_supabase_js/generated/auth-admin-inviteuserbyemail.mdx
+3 -4
View File
@@ -95,7 +95,7 @@ Optional user metadata
</h4>
<div class="method-list-item-description">
A URL or mobile address to send the user to after they are confirmed.
A URL or mobile deeplink to send the user to after they are confirmed.
</div>
@@ -109,12 +109,11 @@ A URL or mobile address to send the user to after they are confirmed.
## Notes
- Requires a `service_role` key.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
- Sends an invite link to the user's email address.
## Examples
### Basic example.
### Invite a user
```js
const { data, error } = await supabase.auth.admin.inviteUserByEmail(
apps/reference/_supabase_js/generated/auth-admin-listusers.mdx
+8 -7
View File
@@ -13,18 +13,19 @@ Get a list of users.
This function should only be called on a server. Never expose your `service_role` key in the browser.
```js
const { data: user, error } = await supabase.auth.admin.listUsers()
const {
data: { users },
error,
} = await supabase.auth.admin.listUsers()
```
## Notes
- Requires a `service_role` key.
- This function should be called on a server. Never expose your `service_role` key in the browser.
## Examples
### Get a full list of users.
```js
const { data: user, error } = await supabase.auth.admin.listUsers()
const {
data: { users },
error,
} = await supabase.auth.admin.listUsers()
```
apps/reference/_supabase_js/generated/auth-admin-updateuserbyid.mdx
+11 -34
View File
@@ -76,11 +76,11 @@ No description provided.
</h4>
<div class="method-list-item-description">
A custom data object for app_metadata that.
A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.
Only a service role can modify.
Can be any JSON that includes app-specific info, such as identity providers, roles, and other
The `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other
access control information.
</div>
@@ -101,7 +101,9 @@ access control information.
</h4>
<div class="method-list-item-description">
A custom data object for user_metadata that a user can modify. Can be any JSON.
A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
The `data` should be a JSON object that includes user-specific info, such as their first and last name.
</div>
@@ -127,26 +129,6 @@ The user's email.
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
email_change_token
</span>
<span className="method-list-item-label-badge false">
optional
</span>
<span className="method-list-item-validation">
<code>string</code>
</span>
</h4>
<div class="method-list-item-description">
An email change token.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
@@ -161,7 +143,7 @@ An email change token.
</h4>
<div class="method-list-item-description">
Sets if a user has confirmed their email address.
Confirms the user's email address if set to true.
Only a service role can modify.
@@ -223,7 +205,7 @@ The user's phone.
</h4>
<div class="method-list-item-description">
Sets if a user has confirmed their phone number.
Confirms the user's phone number if set to true.
Only a service role can modify.
@@ -245,13 +227,13 @@ Only a service role can modify.
</h4>
<div class="method-list-item-description">
A custom data object for user_metadata.
Can be any JSON.
A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
Only a service role can modify.
Note: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,
The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.
Note: When using the GoTrueAdminApi and wanting to modify a user's metadata,
this attribute is used instead of UserAttributes data.
</div>
@@ -264,11 +246,6 @@ this attribute is used instead of UserAttributes data.
</ul>
## Notes
- Requires a `service_role` key.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
## Examples
### Updates a user's email.
apps/reference/_supabase_js/generated/auth-getsession.mdx
+2 -2
View File
@@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Returns the session data, refreshing it if necessary.
If no session is detected, the session returned will be null.
Returns the session, refreshing it if necessary.
The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.
```js
const { data, error } = await supabase.auth.getSession()
apps/reference/_supabase_js/generated/auth-getuser.mdx
+2 -2
View File
@@ -44,8 +44,8 @@ Takes in an optional access token jwt. If no jwt is provided, getUser() will att
## Notes
- This method gets the user object using the current session.
- Fetches the user object from the database instead of local storage.
- This method gets the user object from the current session.
- Fetches the user object from the database instead of local session.
## Examples
apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx
+4
View File
@@ -42,6 +42,10 @@ A callback function to be invoked when an auth event happens.
</ul>
## Notes
- Types of auth events: `SIGNED_IN`, `SIGNED_OUT`, `TOKEN_REFRESHED`, `USER_UPDATED`, `USER_DELETED`, `PASSWORD_RECOVERY`
## Examples
### Listen to auth changes
apps/reference/_supabase_js/generated/auth-resetpasswordforemail.mdx
+5 -5
View File
@@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Sends a reset request to an email address.
Sends a password reset request to an email address.
```js
const { error, data } = await supabase.auth.resetPasswordForEmail(email, options: {
@@ -95,7 +95,7 @@ Verification token received when the user completes the captcha on the site.
</h4>
<div class="method-list-item-description">
A URL to send the user to after they are confirmed.
The URL to send the user to after they click the password reset link.
</div>
@@ -109,15 +109,15 @@ A URL to send the user to after they are confirmed.
## Notes
Sends a reset request to an email address.
Sends a password reset request to an email address.
When the user clicks the reset link in the email they will be forwarded to the site url or the redirect url specified:
When the user clicks the password reset link in the email, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings).
`<SITE_URL>#access_token=x&refresh_token=y&expires_in=z&token_type=bearer&type=recovery`
Your app must detect `type=recovery` in the fragment and display a password reset form to the user.
You should then use the access_token in the url and new password to update the user as follows:
You should then [update the user](/docs/reference/javascript/next/auth-updateuser) as follows:
```js
const { error, data } = await supabase.auth.updateUser({
apps/reference/_supabase_js/generated/auth-setsession.mdx
+12 -7
View File
@@ -8,11 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid.
Sets the session data from refresh token and returns current session or an error if the refresh token is invalid.
```js
const { data, error } = supabase.auth.setSession(refresh_token)
}
const { data, error } = supabase.auth.setSession(refresh_token)
```
## Parameters
@@ -33,7 +32,7 @@ Sets the session data from refresh_token and returns current session or an error
</h4>
<div class="method-list-item-description">
The refresh token returned by gotrue.
A refresh token returned by supabase auth.
</div>
@@ -41,13 +40,19 @@ The refresh token returned by gotrue.
</ul>
## Notes
- `setSession()` takes in a refresh token and uses it to get a new session.
- The refresh token can only be used once to obtain a new session.
- Refresh token rotation (see [`REFRESH_TOKEN_ROTATION_ENABLED`](https://supabase.com/docs/reference/auth/config#refresh_token_rotation_enabled)) is enabled by default on all projects to guard against replay attacks.
- You can configure the [`REFRESH_TOKEN_REUSE_INTERVAL`](https://supabase.com/docs/reference/auth/config#refresh_token_reuse_interval) which provides a short window in which the same refresh token can be used multiple times in the event of concurrency or offline issues.
## Examples
### Basic example.
### Refresh the session
Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid.
```js
const { data, error } = supabase.auth.setSession(refresh_token)
}
const { data, error } = supabase.auth.setSession(refresh_token)
```
apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx
+8 -9
View File
@@ -116,7 +116,7 @@ An object of query params
</h4>
<div class="method-list-item-description">
A URL to send the user to after they are confirmed (OAuth logins only).
A URL to send the user to after they are confirmed.
</div>
@@ -159,7 +159,7 @@ A space-separated list of scopes granted to the OAuth application.
## Examples
### Sign in using a third-party provider.
### Sign in using a third-party provider
```js
const { data, error } = await supabase.auth.signInWithOAuth({
@@ -167,14 +167,13 @@ const { data, error } = await supabase.auth.signInWithOAuth({
})
```
### Sign in using a third-party provider with redirect.
### Sign in using a third-party provider with redirect
The `redirectTo` param will only applied on the callback made from the third-party provider. It does not redirect the user immediately after invoking this method.
In order for the `redirectTo` param to be allowed, one needs to include it in an allowlist. Supabase supports this for
any URL path on your website (the URL must either be on the same domain as your Site URL [see Auth>Settings in dashboard], or must match one of the Additional Redirect URLs [also in Auth>Settings]).
When the third-party provider successfully authenticates the user, the provider will redirect the user to the URL specified in the `redirectTo` parameter. This parameter defaults to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). It does not redirect the user immediately after invoking this method.
You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings).
```js
const { user, session, error } = await supabase.auth.signInWithOAuth({
const { data, error } = await supabase.auth.signInWithOAuth({
provider: 'github'
options: {
redirectTo: 'https://example.com/welcome'
@@ -182,10 +181,10 @@ const { user, session, error } = await supabase.auth.signInWithOAuth({
}
```
### Sign in with scopes.
### Sign in with scopes
If you need additional data from an OAuth provider, you can include a space-separated list of scopes in your request to get back an OAuth provider token.
You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider.
You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider. The list of scopes will be documented by the third-party provider you are using and specifying scopes will enable you to use the OAuth provider token to call additional APIs supported by the third-party provider to get more information.
```js
const { data, error } = await supabase.auth.signInWithOAuth({
apps/reference/_supabase_js/generated/auth-signinwithotp.mdx
+11 -8
View File
@@ -8,7 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Passwordless method for logging in an existing user.
Log in a user using magiclink or a one-time password (OTP).
If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.
If the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.
If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.
```js
const { data, error } = await supabase.auth.signInWithOtp({
@@ -289,17 +292,17 @@ If set to false, this method will not create a new user. Defaults to true.
## Notes
- This method is used for passwordless sign-ins where an otp is sent to the user's email or phone number.
- Requires either an email or phone number.
- If you're using an email, you can configure whether you want the user to receive a magiclink or an otp.
- If you're using phone, you can configure whether you want the user to receive a magiclink or an otp.
- The magic link's destination URL is determined by the SITE_URL config variable. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.
- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.
- If you're using phone, you can configure whether you want the user to receive a OTP.
- The magic link's destination URL is determined by the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings).
## Examples
### Sign in with email.
The user will be sent an otp to their email. By default, a given user can only request an otp once every 60 seconds.
The user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds.
```js
const { data, error } = await supabase.auth.signInWithOtp({
@@ -307,9 +310,9 @@ const { data, error } = await supabase.auth.signInWithOtp({
})
```
### Sign in with sms otp.
### Sign in with SMS OTP.
The user will be sent an otp to their phone number. By default, a given user can only request an otp once every 60 seconds.
The user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds.
```js
const { data, error } = await supabase.auth.signInWithPassword({
apps/reference/_supabase_js/generated/auth-signinwithpassword.mdx
+5 -9
View File
@@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Log in an existing user, or login via a third-party provider.
Log in an existing user with an email and password or phone and password.
```js
const { data, error } = await supabase.auth.signInWithPassword({
@@ -274,9 +274,7 @@ Verification token received when the user completes the captcha on the site.
## Examples
### Sign in with Email.
Sign in with email and password. After a user has verified their email, they can use the [`signInWithPassword()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method.
### Sign in with email and password
```js
const { data, error } = await supabase.auth.signInWithPassword({
@@ -285,9 +283,7 @@ const { data, error } = await supabase.auth.signInWithPassword({
})
```
### Sign in with Phone.
Supabase supports Phone Auth. After a user has verified their number, they can use the [`signIn()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method.
### Sign in with phone and password
```js
const { data, error } = await supabase.auth.signInWithPassword({
@@ -295,8 +291,8 @@ const { data, error } = await supabase.auth.signInWithPassword({
password: 'some-password',
})
// After receiving an SMS with One Time Password.
let { data, error } = await supabase.auth.verifyOtp({
// After receiving a SMS with a OTP.
const { data, error } = await supabase.auth.verifyOtp({
phone: '+13334445555',
token: '123456',
})
apps/reference/_supabase_js/generated/auth-signout.mdx
+5 -1
View File
@@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Inside a browser context, `signOut()` will remove the logged in user from the browser session
and log them out - removing all items from localstorage and then trigger a "SIGNED_OUT" event.
and log them out - removing all items from localstorage and then trigger a `"SIGNED_OUT"` event.
For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.
There is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.
@@ -18,6 +18,10 @@ There is no way to revoke a user's access token jwt until it expires. It is reco
const { error } = await supabase.auth.signOut()
```
## Notes
- In order to use the `signOut()` method, the user needs to be signed in first.
## Examples
### Sign out
apps/reference/_supabase_js/generated/auth-signup.mdx
+15 -10
View File
@@ -158,7 +158,9 @@ Verification token received when the user completes the captcha on the site.
</h4>
<div class="method-list-item-description">
The user's metadata.
A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
The `data` should be a JSON object that includes user-specific info, such as their first and last name.
</div>
@@ -288,7 +290,9 @@ Verification token received when the user completes the captcha on the site.
</h4>
<div class="method-list-item-description">
The user's metadata.
A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
The `data` should be a JSON object that includes user-specific info, such as their first and last name.
</div>
@@ -330,14 +334,15 @@ The redirect url embedded in the email link
## Notes
- By default, the user will need to verify their email address before logging in. If you would like to change this, you can disable "Email Confirmations" by going to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
- If "Email Confirmations" is turned on, a `user` is returned but `session` will be null
- If "Email Confirmations" is turned off, both a `user` and a `session` will be returned
- When the user confirms their email address, they will be redirected to localhost:3000 by default. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://app.supabase.com/project/_/auth/settings).
- **Confirm email** determines if users need to confirm their email address after signing up.
- If **Confirm email** is enabled, a `user` is returned but `session` is null.
- If **Confirm email** is disabled, both a `user` and a `session` are returned.
- When the user confirms their email address, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings).
- If signUp() is called for an existing confirmed user:
- If "Enable email confirmations" is enabled on the "Authentication" -> "Settings" page, an obfuscated / fake user object will be returned.
- If "Enable email confirmations" is disabled, an error with a message "User already registered" will be returned.
- To check if a user already exists, refer to getUser().
- If **Confirm email** is enabled in [your project](https://app.supabase.com/project/_/auth/settings), an obfuscated/fake user object is returned.
- If **Confirm email** is disabled, the error message, `User already registered` is returned.
- To fetch the currently logged-in user, refer to [`getUser()`](/docs/reference/javascript/next/auth-getuser).
## Examples
@@ -350,7 +355,7 @@ const { data, error } = await supabase.auth.signUp({
})
```
### Sign up with additional user meta data.
### Sign up with additional user metadata.
```js
const { data, error } = await supabase.auth.signUp({
apps/reference/_supabase_js/generated/auth-updateuser.mdx
+11 -31
View File
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'
Updates user data, if there is a logged in user.
```js
const { user, error } = await supabase.auth.updateUser({
const { data, error } = await supabase.auth.updateUser({
data: { hello: 'world' },
})
```
@@ -55,7 +55,9 @@ No description provided.
</h4>
<div class="method-list-item-description">
A custom data object for user_metadata that a user can modify. Can be any JSON.
A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.
The `data` should be a JSON object that includes user-specific info, such as their first and last name.
</div>
@@ -81,26 +83,6 @@ The user's email.
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
email_change_token
</span>
<span className="method-list-item-label-badge false">
optional
</span>
<span className="method-list-item-validation">
<code>string</code>
</span>
</h4>
<div class="method-list-item-description">
An email change token.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
@@ -149,15 +131,13 @@ The user's phone.
## Notes
User email: Email updates will send an email to both the user's current and new email with a confirmation link by default.
To toggle this behavior off and only send a single confirmation link to the new email, toggle "Double confirm email changes" under "Authentication" -> "Settings" off.
User metadata: It's generally better to store user data in a table inside your public schema (i.e. `public.users`).
Use the `update()` method if you have data which rarely changes or is specific only to the logged in user.
- In order to use the `updateUser()` method, the user needs to be signed in first.
- Email updates will send an email to both the user's current and new email with a confirmation link by default.
To only send a single confirmation link to the user's new email, you can toggle the "Secure email change" setting in [your project](https://app.supabase.com/project/_/auth/settings).
## Examples
### Update email for authenticated user.
### Update the email of an authenticated user
Sends a "Confirm Email Change" email to the new email address.
@@ -167,7 +147,7 @@ const { data, error } = await supabase.auth.updateUser({
})
```
### Update password for authenticated user.
### Update the password of an authenticated user
```js
const { data, error } = await supabase.auth.updateUser({
@@ -175,10 +155,10 @@ const { data, error } = await supabase.auth.updateUser({
})
```
### Update a user's metadata.
### Update the user's metadata.
```js
const { user, error } = await supabase.auth.updateUser({
const { data, error } = await supabase.auth.updateUser({
data: { hello: 'world' },
})
```
apps/reference/_supabase_js/generated/auth-verifyotp.mdx
+3 -63
View File
@@ -87,72 +87,12 @@ No description provided.
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
options
</span>
<span className="method-list-item-label-badge required">
required
</span>
<span className="method-list-item-validation">
<code>object</code>
</span>
</h4>
<div class="method-list-item-description">
No description provided.
</div>
<ul className="method-list-group">
<h5 class="method-list-title method-list-title-isChild expanded">Properties</h5>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
captchaToken
</span>
<span className="method-list-item-label-badge false">
optional
</span>
<span className="method-list-item-validation">
<code>string</code>
</span>
</h4>
<div class="method-list-item-description">
Verification token received when the user completes the captcha on the site.
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
redirectTo
</span>
<span className="method-list-item-label-badge false">
optional
</span>
<span className="method-list-item-validation">
<code>string</code>
</span>
</h4>
<div class="method-list-item-description">
A URL to send the user to after they are confirmed.
</div>
</li>
</ul>
</li>
## Notes
</ul>
- The `verifyOtp` method takes in different verification types. If a phone number is used, the type can either be `sms` or `phone_change`. If an email address is used, the type can be one of the following: `signup`, `magiclink`, `recovery`, `invite` or `email_change`.
- The verification type used should be determined based on the corresponding auth method called before `verifyOtp` to sign up / sign-in a user.
## Examples
apps/reference/_supabase_js/generated/removeallchannels.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ supabase.removeAllChannels()
## Examples
### Removes all channels
### Remove all channels
```js
supabase.removeAllChannels()
apps/reference/_supabase_js/generated/removechannel.mdx
+1 -1
View File
@@ -831,7 +831,7 @@ No description provided.
## Examples
### Remove a channel
### Removes a channel
```js
supabase.removeChannel(myChannel)
apps/reference/_supabase_js/generated/supabase-auth-admin-api.mdx
+14
View File
@@ -0,0 +1,14 @@
---
id: supabase-auth-admin-api
title: 'Overview'
slug: /supabase-auth-admin-api
custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v2_legacy.yml
---
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
## Notes
- Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser.
apps/reference/nav/supabase_js_sidebars.js
+1
View File
@@ -52,6 +52,7 @@ const sidebars = {
type: 'category',
label: 'Auth (Server Only)',
items: [
'generated/supabase-auth-admin-api',
'generated/auth-admin-listusers',
'generated/auth-admin-createuser',
'generated/auth-admin-deleteuser',
spec/enrichments/tsdoc_v2/combined.json
+5211 -3758
View File
File diff suppressed because it is too large. Load diff
spec/enrichments/tsdoc_v2/gotrue.json
+10926 -8829
View File
File diff suppressed because it is too large. Load diff
spec/enrichments/tsdoc_v2/gotrue_dereferenced.json
+5211 -3758
View File
File diff suppressed because it is too large. Load diff
spec/supabase_js_v2_legacy.yml
+72 -76
View File
@@ -85,14 +85,15 @@ pages:
title: 'signUp()'
$ref: '@supabase/gotrue-js.GoTrueClient.signUp'
notes: |
- By default, the user will need to verify their email address before logging in. If you would like to change this, you can disable "Email Confirmations" by going to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
- If "Email Confirmations" is turned on, a `user` is returned but `session` will be null
- If "Email Confirmations" is turned off, both a `user` and a `session` will be returned
- When the user confirms their email address, they will be redirected to localhost:3000 by default. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://app.supabase.com/project/_/auth/settings).
- **Confirm email** determines if users need to confirm their email address after signing up.
- If **Confirm email** is enabled, a `user` is returned but `session` is null.
- If **Confirm email** is disabled, both a `user` and a `session` are returned.
- When the user confirms their email address, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings).
- If signUp() is called for an existing confirmed user:
- If "Enable email confirmations" is enabled on the "Authentication" -> "Settings" page, an obfuscated / fake user object will be returned.
- If "Enable email confirmations" is disabled, an error with a message "User already registered" will be returned.
- To check if a user already exists, refer to getUser().
- If **Confirm email** is enabled in [your project](https://app.supabase.com/project/_/auth/settings), an obfuscated/fake user object is returned.
- If **Confirm email** is disabled, the error message, `User already registered` is returned.
- To fetch the currently logged-in user, refer to [`getUser()`](/docs/reference/javascript/next/auth-getuser).
examples:
- name: Sign up.
isSpotlight: true
@@ -103,7 +104,7 @@ pages:
password: 'example-password',
})
```
- name: Sign up with additional user meta data.
- name: Sign up with additional user metadata.
isSpotlight: false
js: |
```js
@@ -126,10 +127,8 @@ pages:
notes: |
- Requires either an email and password or a phone number and password.
examples:
- name: Sign in with Email.
- name: Sign in with email and password
isSpotlight: true
description: |
Sign in with email and password. After a user has verified their email, they can use the [`signInWithPassword()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method.
js: |
```js
const { data, error } = await supabase.auth.signInWithPassword({
@@ -137,10 +136,8 @@ pages:
password: 'example-password',
})
```
- name: Sign in with Phone.
- name: Sign in with phone and password
isSpotlight: false
description: |
Supabase supports Phone Auth. After a user has verified their number, they can use the [`signIn()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method.
js: |
```js
const { data, error } = await supabase.auth.signInWithPassword({
@@ -148,8 +145,8 @@ pages:
password: 'some-password',
})
// After receiving an SMS with One Time Password.
let { data, error } = await supabase.auth.verifyOtp({
// After receiving a SMS with a OTP.
const { data, error } = await supabase.auth.verifyOtp({
phone: '+13334445555',
token: '123456',
})
@@ -158,24 +155,24 @@ pages:
title: 'signInWithOtp()'
$ref: '@supabase/gotrue-js.GoTrueClient.signInWithOtp'
notes: |
- This method is used for passwordless sign-ins where an otp is sent to the user's email or phone number.
- Requires either an email or phone number.
- If you're using an email, you can configure whether you want the user to receive a magiclink or an otp.
- If you're using phone, you can configure whether you want the user to receive a magiclink or an otp.
- The magic link's destination URL is determined by the SITE_URL config variable. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.
- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.
- If you're using phone, you can configure whether you want the user to receive a OTP.
- The magic link's destination URL is determined by the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings).
examples:
- name: Sign in with email.
isSpotlight: true
description: The user will be sent an otp to their email. By default, a given user can only request an otp once every 60 seconds.
description: The user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds.
js: |
```js
const { data, error } = await supabase.auth.signInWithOtp({
email: 'example@email.com',
})
```
- name: Sign in with sms otp.
- name: Sign in with SMS OTP.
isSpotlight: false
description: The user will be sent an otp to their phone number. By default, a given user can only request an otp once every 60 seconds.
description: The user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds.
js: |
```js
const { data, error } = await supabase.auth.signInWithPassword({
@@ -189,7 +186,7 @@ pages:
- This method is used for signing in using a third-party provider.
- Supabase supports many different [third-party providers](https://supabase.com/docs/guides/auth#providers).
examples:
- name: Sign in using a third-party provider.
- name: Sign in using a third-party provider
isSpotlight: true
js: |
```js
@@ -197,26 +194,25 @@ pages:
provider: 'github'
})
```
- name: Sign in using a third-party provider with redirect.
- name: Sign in using a third-party provider with redirect
isSpotlight: false
description: |
The `redirectTo` param will only applied on the callback made from the third-party provider. It does not redirect the user immediately after invoking this method.
In order for the `redirectTo` param to be allowed, one needs to include it in an allowlist. Supabase supports this for
any URL path on your website (the URL must either be on the same domain as your Site URL [see Auth>Settings in dashboard], or must match one of the Additional Redirect URLs [also in Auth>Settings]).
When the third-party provider successfully authenticates the user, the provider will redirect the user to the URL specified in the `redirectTo` parameter. This parameter defaults to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). It does not redirect the user immediately after invoking this method.
You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings).
js: |
```js
const { user, session, error } = await supabase.auth.signInWithOAuth({
const { data, error } = await supabase.auth.signInWithOAuth({
provider: 'github'
options: {
redirectTo: 'https://example.com/welcome'
}
}
```
- name: Sign in with scopes.
- name: Sign in with scopes
isSpotlight: false
description: |
If you need additional data from an OAuth provider, you can include a space-separated list of scopes in your request to get back an OAuth provider token.
You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider.
You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider. The list of scopes will be documented by the third-party provider you are using and specifying scopes will enable you to use the OAuth provider token to call additional APIs supported by the third-party provider to get more information.
js: |
```js
const { data, error } = await supabase.auth.signInWithOAuth({
@@ -230,6 +226,8 @@ pages:
auth.signOut():
title: 'signOut()'
$ref: '@supabase/gotrue-js.GoTrueClient.signOut'
notes: |
- In order to use the `signOut()` method, the user needs to be signed in first.
examples:
- name: Sign out
isSpotlight: true
@@ -240,6 +238,9 @@ pages:
auth.verifyOtp():
title: 'verifyOtp()'
$ref: '@supabase/gotrue-js.GoTrueClient.verifyOtp'
notes: |
- The `verifyOtp` method takes in different verification types. If a phone number is used, the type can either be `sms` or `phone_change`. If an email address is used, the type can be one of the following: `signup`, `magiclink`, `recovery`, `invite` or `email_change`.
- The verification type used should be determined based on the corresponding auth method called before `verifyOtp` to sign up / sign-in a user.
examples:
- name: Verify Sms One-Time Password (OTP)
isSpotlight: true
@@ -267,8 +268,8 @@ pages:
title: 'getUser()'
$ref: '@supabase/gotrue-js.GoTrueClient.getUser'
notes: |
- This method gets the user object using the current session.
- Fetches the user object from the database instead of local storage.
- This method gets the user object from the current session.
- Fetches the user object from the database instead of local session.
examples:
- name: Get the logged in user with the current existing session
isSpotlight: true
@@ -286,49 +287,52 @@ pages:
title: 'updateUser()'
$ref: '@supabase/gotrue-js.GoTrueClient.updateUser'
notes: |
User email: Email updates will send an email to both the user's current and new email with a confirmation link by default.
To toggle this behavior off and only send a single confirmation link to the new email, toggle "Double confirm email changes" under "Authentication" -> "Settings" off.
User metadata: It's generally better to store user data in a table inside your public schema (i.e. `public.users`).
Use the `update()` method if you have data which rarely changes or is specific only to the logged in user.
- In order to use the `updateUser()` method, the user needs to be signed in first.
- Email updates will send an email to both the user's current and new email with a confirmation link by default.
To only send a single confirmation link to the user's new email, you can toggle the "Secure email change" setting in [your project](https://app.supabase.com/project/_/auth/settings).
examples:
- name: Update email for authenticated user.
- name: Update the email of an authenticated user
description: Sends a "Confirm Email Change" email to the new email address.
isSpotlight: false
js: |
```js
const { data, error } = await supabase.auth.updateUser({email: 'new@email.com'})
```
- name: Update password for authenticated user.
- name: Update the password of an authenticated user
isSpotlight: false
js: |
```js
const { data, error } = await supabase.auth.updateUser({password: 'new password'})
```
- name: Update a user's metadata.
- name: Update the user's metadata.
isSpotlight: true
js: |
```js
const { user, error } = await supabase.auth.updateUser({
const { data, error } = await supabase.auth.updateUser({
data: { hello: 'world' }
})
```
auth.setSession():
title: 'setSession()'
$ref: '@supabase/gotrue-js.GoTrueClient.setSession'
notes: |
- `setSession()` takes in a refresh token and uses it to get a new session.
- The refresh token can only be used once to obtain a new session.
- Refresh token rotation (see [`REFRESH_TOKEN_ROTATION_ENABLED`](https://supabase.com/docs/reference/auth/config#refresh_token_rotation_enabled)) is enabled by default on all projects to guard against replay attacks.
- You can configure the [`REFRESH_TOKEN_REUSE_INTERVAL`](https://supabase.com/docs/reference/auth/config#refresh_token_reuse_interval) which provides a short window in which the same refresh token can be used multiple times in the event of concurrency or offline issues.
examples:
- name: Basic example.
- name: Refresh the session
description: Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid.
isSpotlight: true
js: |
```js
const { data, error } = supabase.auth.setSession(refresh_token)
}
```
auth.onAuthStateChange():
title: 'onAuthStateChange()'
$ref: '@supabase/gotrue-js.GoTrueClient.onAuthStateChange'
notes: |
- Types of auth events: `SIGNED_IN`, `SIGNED_OUT`, `TOKEN_REFRESHED`, `USER_UPDATED`, `USER_DELETED`, `PASSWORD_RECOVERY`
examples:
- name: Listen to auth changes
isSpotlight: true
@@ -380,43 +384,43 @@ pages:
if (event == 'PASSWORD_RECOVERY') console.log('PASSWORD_RECOVERY', session)
})
```
Supabase Auth Admin Api:
title: 'Overview'
notes: |
- Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser.
auth.admin.getUserById():
title: 'getUserById()'
$ref: '@supabase/gotrue-js.GoTrueAdminApi.getUserById'
notes: |
- Fetches the user object from the database instead of local storage.
- Note that user() fetches the user object from local storage which might not be the most updated.
- Requires the user's access_token.
- Fetches the user object from the database based on the user's id.
- The `getUserById()` method requires the user's id which maps to the `auth.users.id` column.
examples:
- name: Fetch the user object using the access_token jwt.
isSpotlight: true
js: |
```js
const { user, error } = await supabase.auth.admin.getUserById(1)
const { data, error } = await supabase.auth.admin.getUserById(1)
```
auth.admin.listUsers():
title: 'listUsers()'
$ref: '@supabase/gotrue-js.GoTrueAdminApi.listUsers'
notes: |
- Requires a `service_role` key.
- This function should be called on a server. Never expose your `service_role` key in the browser.
examples:
- name: Get a full list of users.
isSpotlight: true
js: |
```js
const { data: user, error } = await supabase.auth.admin.listUsers()
const { data: { users }, error } = await supabase.auth.admin.listUsers()
```
auth.admin.createUser():
title: 'createUser()'
$ref: '@supabase/gotrue-js.GoTrueAdminApi.createUser'
notes: |
- Requires a `service_role` key.
- This function should be called on a server. Never expose your `service_role` key in the browser.
- If you do not provide the `email_confirm` and `phone_confirm` options to this function, both will default to false.
- To confirm the user's email address or phone number, set `email_confirm` or `phone_confirm` to true. Both arguments default to false.
examples:
- name: Create a new user.
- name: Create a new user with custom user metadata
isSpotlight: true
js: |
```js
@@ -426,7 +430,7 @@ pages:
user_metadata: { name: 'Yoda' }
})
```
- name: Auto-confirm email.
- name: Auto-confirm the user's email
js: |
```js
const { data, error } = await supabase.auth.admin.createUser({
@@ -434,7 +438,7 @@ pages:
email_confirm: true
})
```
- name: Auto-confirm phone.
- name: Auto-confirm the user's phone number
js: |
```js
const { data, error } = await supabase.auth.admin.createUser({
@@ -446,10 +450,9 @@ pages:
title: 'deleteUser()'
$ref: '@supabase/gotrue-js.GoTrueAdminApi.deleteUser'
notes: |
- Requires a `service_role` key.
- This function should be called on a server. Never expose your `service_role` key in the browser.
- The `deleteUser()` method requires the user's ID, which maps to the `auth.users.id` column.
examples:
- name: Remove a user completely.
- name: Removes a user
isSpotlight: true
js: |
```js
@@ -462,10 +465,9 @@ pages:
title: 'inviteUserByEmail()'
$ref: '@supabase/gotrue-js.GoTrueAdminApi.inviteUserByEmail'
notes: |
- Requires a `service_role` key.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
- Sends an invite link to the user's email address.
examples:
- name: Basic example.
- name: Invite a user
isSpotlight: true
js: |
```js
@@ -476,15 +478,15 @@ pages:
title: 'resetPasswordForEmail()'
$ref: '@supabase/gotrue-js.GoTrueClient.resetPasswordForEmail'
notes: |
Sends a reset request to an email address.
Sends a password reset request to an email address.
When the user clicks the reset link in the email they will be forwarded to the site url or the redirect url specified:
When the user clicks the password reset link in the email, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings).
`<SITE_URL>#access_token=x&refresh_token=y&expires_in=z&token_type=bearer&type=recovery`
Your app must detect `type=recovery` in the fragment and display a password reset form to the user.
You should then use the access_token in the url and new password to update the user as follows:
You should then [update the user](/docs/reference/javascript/next/auth-updateuser) as follows:
```js
const { error, data } = await supabase.auth.updateUser({ password : new_password })
@@ -502,9 +504,6 @@ pages:
auth.admin.generateLink():
title: 'generateLink()'
$ref: '@supabase/gotrue-js.GoTrueAdminApi.generateLink'
notes: |
- Requires a `service_role` key.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
examples:
- name: Generate a signup link.
isSpotlight: true
@@ -531,9 +530,6 @@ pages:
auth.admin.updateUserById():
title: 'updateUserById()'
$ref: '@supabase/gotrue-js.GoTrueAdminApi.updateUserById'
notes: |
- Requires a `service_role` key.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
examples:
- name: Updates a user's email.
isSpotlight: false
@@ -1088,7 +1084,7 @@ pages:
notes: |
- Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed.
examples:
- name: Remove a channel
- name: Removes a channel
isSpotlight: true
js: |
```js
@@ -1101,7 +1097,7 @@ pages:
notes: |
- Removing channels is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed.
examples:
- name: Removes all channels
- name: Remove all channels
isSpotlight: true
js: |
```js