mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
docs: use sign in terminology across guides and style guides (#49877)
## What kind of change does this PR introduce? Docs update. Aligns documentation and style guides with the **Sign in / Sign out / Sign up** platform standard. Closes DOCS-1328. Related to [#49874](https://github.com/supabase/supabase/pull/49874). ## What is the current behavior? Docs style guides prefer _login_ / _log in_. Guide prose uses mixed login and sign in wording. ## What is the new behavior? - [WORD_LIST.md](apps/docs/WORD_LIST.md) and [copywriting.mdx](apps/design-system/content/docs/copywriting.mdx) document the sign in standard - Design-system auth examples updated - Guide prose and API reference spec descriptions updated ### Terminology **Standard:** Use _sign in_, _sign out_, and _sign up_ as verbs. Use _sign-in_, _sign-out_, and _sign-up_ as nouns and adjectives. Match Studio UI labels (**Sign in**, **Sign out**, **Sign up**). **Preserved intentionally:** | Category | Keep as-is | Example | | -------- | ---------- | ------- | | Feature name | social login | `/social-login`, `features.mdx` heading, OAuth provider section | | URL slugs | `login` in paths | `/phone-login`, `/login-flows`, `choosing-login-flow` | | CLI | `supabase login` / `supabase logout` | Reference ids `supabase-login` / `supabase-logout`; executable commands unchanged | | SDK methods | `logout()` | Kotlin/Swift method names in API reference titles and examples | | Third-party UI | Provider product labels | Facebook Login, Kakao Login, portal **Login** buttons | | Postgres | Database terminology | login privileges, login credentials, login via role | | Audit/logging | Log prose | "Generates the following **log** in the Postgres Logs" | | Code and routes | Paths and filenames | `app/login/`, `Login.tsx`, `demos/android-login` | | External URLs | Third-party login pages | `dash.cloudflare.com/login`, `console.neon.tech/login`, `vercel.com/login` | | API identifiers | Event and field names | Audit actions `login`/`logout`, `should_logout_user` | ## To test - Run `pnpm lint:mdx` in `apps/docs` - Spot-check `features.mdx`, `social-login.mdx`, and a provider guide (e.g. Facebook, Kakao) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized authentication terminology across guides, reference material, CLI documentation, and copywriting guidance using “sign in,” “sign out,” and “sign up.” * Updated authentication instructions, headings, link text, examples, and SSO guidance for clearer, more consistent wording. * Corrected related grammar, spelling, hyphenation, and documentation links while preserving established product names and implementation commands. * **Style** * Refined code examples with consistent import ordering and spacing. * **Examples** * Updated authentication button and menu labels to “Sign in” and “Sign out.” <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Danny White authored and GitHub committed
1 parent
bdfd69e955
commit
24be387cdb
147 files changed
+630
-601
No files matched your search
@@ -172,7 +172,7 @@ commands:
|
||||
- id: supabase-projects-list
|
||||
title: supabase projects list
|
||||
summary: List all Supabase projects
|
||||
description: List all Supabase projects the logged-in user can access.
|
||||
description: List all Supabase projects the signed-in user can access.
|
||||
tags: []
|
||||
links: []
|
||||
usage: |-
|
||||
@@ -218,7 +218,7 @@ commands:
|
||||
- id: supabase-orgs-list
|
||||
title: supabase orgs list
|
||||
summary: List all organizations
|
||||
description: List all organizations the logged-in user belongs.
|
||||
description: List all organizations the signed-in user belongs.
|
||||
tags: []
|
||||
links: []
|
||||
usage: |-
|
||||
|
||||
@@ -730,7 +730,7 @@ commands:
|
||||
title: supabase sso remove
|
||||
summary: Remove an existing SSO identity provider
|
||||
description: |
|
||||
Remove a connection to an already added SSO identity provider. Removing the provider will prevent existing users from logging in. Please treat this command with care.
|
||||
Remove a connection to an already added SSO identity provider. Removing the provider will prevent existing users from signing in. Please treat this command with care.
|
||||
examples:
|
||||
- id: basic-usage
|
||||
name: Remove a provider
|
||||
@@ -1085,7 +1085,7 @@ commands:
|
||||
- id: supabase-projects-list
|
||||
title: supabase projects list
|
||||
summary: List all Supabase projects
|
||||
description: List all Supabase projects the logged-in user can access.
|
||||
description: List all Supabase projects the signed-in user can access.
|
||||
tags: []
|
||||
links: []
|
||||
usage: supabase projects list
|
||||
@@ -1346,7 +1346,7 @@ commands:
|
||||
- id: supabase-orgs-list
|
||||
title: supabase orgs list
|
||||
summary: List all organizations
|
||||
description: List all organizations the logged-in user belongs.
|
||||
description: List all organizations the signed-in user belongs to.
|
||||
tags: []
|
||||
links: []
|
||||
usage: supabase orgs list
|
||||
@@ -1355,7 +1355,7 @@ commands:
|
||||
- id: supabase-orgs-create
|
||||
title: supabase orgs create
|
||||
summary: Create an organization
|
||||
description: Create an organization for the logged-in user.
|
||||
description: Create an organization for the signed-in user.
|
||||
tags: []
|
||||
links: []
|
||||
usage: supabase orgs create
|
||||
@@ -1794,7 +1794,7 @@ commands:
|
||||
summary: Authenticate using an access token
|
||||
description: |2
|
||||
|
||||
Connect the Supabase CLI to your Supabase account by logging in with your [personal access token](https://supabase.com/dashboard/account/tokens).
|
||||
Connect the Supabase CLI to your Supabase account by signing in with your [personal access token](https://supabase.com/dashboard/account/tokens).
|
||||
|
||||
Your access token is stored securely in [native credentials storage](https://github.com/zalando/go-keyring#dependencies). If native credentials storage is unavailable, it will be written to a plain text file at `~/.supabase/access-token`.
|
||||
|
||||
|
||||
@@ -1489,7 +1489,7 @@ parameters:
|
||||
required: false
|
||||
default: ''
|
||||
description: |
|
||||
Force log out after the specified duration. Sample values include: '50m', '20h'.
|
||||
Force sign out after the specified duration. Sample values include: '50m', '20h'.
|
||||
links:
|
||||
- name: 'Auth Sessions'
|
||||
link: 'https://supabase.com/docs/guides/auth/sessions'
|
||||
@@ -1500,7 +1500,7 @@ parameters:
|
||||
required: false
|
||||
default: ''
|
||||
description: |
|
||||
Force log out if the user has been inactive longer than the specified duration. Sample values include: '50m', '20h'.
|
||||
Force sign out if the user has been inactive longer than the specified duration. Sample values include: '50m', '20h'.
|
||||
links:
|
||||
- name: 'Auth Sessions'
|
||||
link: 'https://supabase.com/docs/guides/auth/sessions'
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
title: 'Introduction'
|
||||
---
|
||||
|
||||
This reference documents every object and method available in Supabase's Flutter library, [supabase-flutter](https://pub.dev/packages/supabase_flutter). You can use supabase-flutter to interact with your Postgres database, listen to database changes, invoke Deno Edge Functions, build login and user management functionality, and manage large files.
|
||||
This reference documents every object and method available in Supabase's Flutter library, [supabase-flutter](https://pub.dev/packages/supabase_flutter). You can use supabase-flutter to interact with your Postgres database, listen to database changes, invoke Deno Edge Functions, build sign-in and user management functionality, and manage large files.
|
||||
|
||||
We also provide a [supabase](https://pub.dev/packages/supabase) package for non-Flutter projects.
|
||||
@@ -3,7 +3,7 @@ id: introduction
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
This reference documents every object and method available in Supabase's isomorphic JavaScript library, `supabase-js`. You can use `supabase-js` to interact with your Postgres database, listen to database changes, invoke Deno Edge Functions, build login and user management functionality, and manage large files.
|
||||
This reference documents every object and method available in Supabase's isomorphic JavaScript library, `supabase-js`. You can use `supabase-js` to interact with your Postgres database, listen to database changes, invoke Deno Edge Functions, build sign-in and user management functionality, and manage large files.
|
||||
|
||||
To convert SQL queries to `supabase-js` calls, use the [SQL to REST API translator](/docs/guides/api/sql-to-rest).
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ functions:
|
||||
description: |
|
||||
Creates a new user.
|
||||
notes: |
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **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.
|
||||
@@ -138,7 +138,7 @@ functions:
|
||||
- id: sign-in-with-password
|
||||
title: 'SignIn(email, password)'
|
||||
description: |
|
||||
Log in an existing user using email or phone number with password.
|
||||
Sign in an existing user using email or phone number with password.
|
||||
notes: |
|
||||
- Requires either an email and password or a phone number and password.
|
||||
examples:
|
||||
@@ -215,7 +215,7 @@ functions:
|
||||
- id: sign-out
|
||||
title: 'SignOut()'
|
||||
description: |
|
||||
Signs out the current user, if there is a logged in user.
|
||||
Signs out the current user, if there is a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `SignOut()` method, the user needs to be signed in first.
|
||||
examples:
|
||||
@@ -254,9 +254,9 @@ functions:
|
||||
- id: get-user
|
||||
title: 'CurrentUser'
|
||||
description: |
|
||||
Returns the user data, if there is a logged in user.
|
||||
Returns the user data, if there is a signed-in user.
|
||||
examples:
|
||||
- name: Get the logged in user
|
||||
- name: Get the signed-in user
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```c#
|
||||
@@ -265,7 +265,7 @@ functions:
|
||||
- id: update-user
|
||||
title: 'UpdateUser()'
|
||||
description: |
|
||||
Updates user data, if there is a logged in user.
|
||||
Updates user data, if there is a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `UpdateUser()` method, the user needs to be signed in first.
|
||||
- By Default, email updates sends a confirmation link to both the user's current and new email.
|
||||
|
||||
@@ -116,7 +116,7 @@ functions:
|
||||
description: |
|
||||
Creates a new user.
|
||||
notes: |
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **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.
|
||||
@@ -135,7 +135,7 @@ functions:
|
||||
- id: sign-in-with-password
|
||||
title: 'SignIn(email, password)'
|
||||
description: |
|
||||
Log in an existing user using email or phone number with password.
|
||||
Sign in an existing user using email or phone number with password.
|
||||
notes: |
|
||||
- Requires either an email and password or a phone number and password.
|
||||
examples:
|
||||
@@ -212,7 +212,7 @@ functions:
|
||||
- id: sign-out
|
||||
title: 'SignOut()'
|
||||
description: |
|
||||
Signs out the current user, if there is a logged in user.
|
||||
Signs out the current user, if there is a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `SignOut()` method, the user needs to be signed in first.
|
||||
examples:
|
||||
@@ -259,9 +259,9 @@ functions:
|
||||
- id: get-user
|
||||
title: 'CurrentUser'
|
||||
description: |
|
||||
Returns the user data, if there is a logged in user.
|
||||
Returns the user data, if there is a signed-in user.
|
||||
examples:
|
||||
- name: Get the logged in user
|
||||
- name: Get the signed-in user
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```c#
|
||||
@@ -270,7 +270,7 @@ functions:
|
||||
- id: update-user
|
||||
title: 'UpdateUser()'
|
||||
description: |
|
||||
Updates user data, if there is a logged in user.
|
||||
Updates user data, if there is a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `UpdateUser()` method, the user needs to be signed in first.
|
||||
- By Default, email updates sends a confirmation link to both the user's current and new email.
|
||||
@@ -1558,7 +1558,7 @@ functions:
|
||||
|
||||
- id: from-create-signed-upload-url
|
||||
description: |
|
||||
Creates a signed URL that can be used to upload a file without requiring a logged-in user. This is useful for handing off uploads to an untrusted client.
|
||||
Creates a signed URL that can be used to upload a file without requiring a signed-in user. This is useful for handing off uploads to an untrusted client.
|
||||
title: 'From().CreateUploadSignedUrl()'
|
||||
notes: |
|
||||
- Policy permissions required:
|
||||
|
||||
@@ -56,7 +56,7 @@ functions:
|
||||
description: |
|
||||
Creates a new user.
|
||||
notes: |
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **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.
|
||||
@@ -107,7 +107,7 @@ functions:
|
||||
- id: sign-in-with-password
|
||||
title: 'signInWithPassword()'
|
||||
description: |
|
||||
Log in an existing user using email or phone number with password.
|
||||
Sign in an existing user using email or phone number with password.
|
||||
notes: |
|
||||
- Requires either an email and password or a phone number and password.
|
||||
examples:
|
||||
@@ -239,7 +239,7 @@ functions:
|
||||
- id: sign-out
|
||||
title: 'signOut()'
|
||||
description: |
|
||||
Signs out the current user, if there is a logged in user.
|
||||
Signs out the current user, if there is a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `signOut()` method, the user needs to be signed in first.
|
||||
examples:
|
||||
@@ -297,9 +297,9 @@ functions:
|
||||
- id: get-user
|
||||
title: 'currentUser'
|
||||
description: |
|
||||
Returns the user data, if there is a logged in user.
|
||||
Returns the user data, if there is a signed-in user.
|
||||
examples:
|
||||
- name: Get the logged in user
|
||||
- name: Get the signed-in user
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```dart
|
||||
@@ -308,7 +308,7 @@ functions:
|
||||
- id: update-user
|
||||
title: 'updateUser()'
|
||||
description: |
|
||||
Updates user data for a logged in user.
|
||||
Updates user data for a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `updateUser()` method, the user needs to be signed in first.
|
||||
- By Default, email updates sends a confirmation link to both the user's current and new email.
|
||||
@@ -750,7 +750,7 @@ functions:
|
||||
- id: parsing-custom-headers
|
||||
name: Parsing custom headers.
|
||||
description: |
|
||||
Any `headers` will be passed through to the function. A common pattern is to pass a logged-in user's JWT token as an Authorization header.
|
||||
Any `headers` will be passed through to the function. A common pattern is to pass a signed-in user's JWT token as an Authorization header.
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```dart
|
||||
|
||||
@@ -121,7 +121,7 @@ functions:
|
||||
description: |
|
||||
Creates a new user.
|
||||
notes: |
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **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.
|
||||
@@ -363,7 +363,7 @@ functions:
|
||||
- id: sign-in-with-password
|
||||
title: 'signInWithPassword()'
|
||||
description: |
|
||||
Log in an existing user using email or phone number with password.
|
||||
Sign in an existing user using email or phone number with password.
|
||||
notes: |
|
||||
- Requires either an email and password or a phone number and password.
|
||||
params:
|
||||
@@ -977,7 +977,7 @@ functions:
|
||||
- id: register-passkey
|
||||
title: 'registerPasskey()'
|
||||
notes: |
|
||||
Registers a new passkey (WebAuthn credential) for the signed in user.
|
||||
Registers a new passkey (WebAuthn credential) for the signed-in user.
|
||||
- Available on `supabase_flutter` 2.15.0 and later as an extension on `GoTrueClient`.
|
||||
- Drives the full WebAuthn ceremony end to end: starts the registration with the Supabase server, calls the `authenticator` you supply to create a credential on the device, and verifies it with the server.
|
||||
- Requires a signed in (non-anonymous) user. If the user has verified MFA factors, the session has to be at `aal2` to manage passkeys.
|
||||
@@ -1011,7 +1011,7 @@ functions:
|
||||
- id: sign-out
|
||||
title: 'signOut()'
|
||||
description: |
|
||||
Signs out the current user, if there is a logged in user.
|
||||
Signs out the current user, if there is a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `signOut()` method, the user needs to be signed in first.
|
||||
params:
|
||||
@@ -1233,9 +1233,9 @@ functions:
|
||||
- id: get-user
|
||||
title: 'currentUser'
|
||||
description: |
|
||||
Returns the user data, if there is a logged in user.
|
||||
Returns the user data, if there is a signed-in user.
|
||||
examples:
|
||||
- name: Get the logged in user
|
||||
- name: Get the signed-in user
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```dart
|
||||
@@ -1280,7 +1280,7 @@ functions:
|
||||
- id: update-user
|
||||
title: 'updateUser()'
|
||||
description: |
|
||||
Updates user data for a logged in user.
|
||||
Updates user data for a signed-in user.
|
||||
notes: |
|
||||
- In order to use the `updateUser()` method, the user needs to be signed in first.
|
||||
- By default, email updates sends a confirmation link to both the user's current and new email.
|
||||
@@ -2298,7 +2298,7 @@ functions:
|
||||
- id: passkey-list
|
||||
title: 'passkey.list()'
|
||||
notes: |
|
||||
Returns the list of passkeys registered to the signed in user.
|
||||
Returns the list of passkeys registered to the signed-in user.
|
||||
examples:
|
||||
- id: list-passkeys
|
||||
name: List the current user's passkeys
|
||||
@@ -2334,7 +2334,7 @@ functions:
|
||||
- id: passkey-delete
|
||||
title: 'passkey.delete()'
|
||||
notes: |
|
||||
Deletes a passkey from the signed in user.
|
||||
Deletes a passkey from the signed-in user.
|
||||
- If the user has verified MFA factors, the session has to be at `aal2` to manage passkeys.
|
||||
params:
|
||||
- name: passkeyId
|
||||
@@ -2354,7 +2354,7 @@ functions:
|
||||
- id: passkey-start-registration
|
||||
title: 'passkey.startRegistration()'
|
||||
notes: |
|
||||
Starts the registration of a new passkey for the signed in user.
|
||||
Starts the registration of a new passkey for the signed-in user.
|
||||
- Requires a signed in (non-anonymous) user.
|
||||
- Pass the returned `options` to the platform's passkey API to create the credential, then call [`passkey.verifyRegistration()`](/docs/reference/dart/auth-passkey-verifyregistration) with the result.
|
||||
- When the server omits `user.name`/`displayName` in the registration options, they are backfilled with `friendlyName` (or a generic `Passkey` default) before the platform ceremony.
|
||||
@@ -3269,7 +3269,7 @@ functions:
|
||||
- id: parsing-custom-headers
|
||||
name: Parsing custom headers.
|
||||
description: |
|
||||
Any `headers` will be passed through to the function. A common pattern is to pass a logged-in user's JWT token as an Authorization header.
|
||||
Any `headers` will be passed through to the function. A common pattern is to pass a signed-in user's JWT token as an Authorization header.
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```dart
|
||||
|
||||
@@ -82,7 +82,7 @@ functions:
|
||||
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 [supabase.com/dashboard](https://supabase.com/dashboard)
|
||||
- By default, the user will need to verify their email address before signing in. If you would like to change this, you can disable "Email Confirmations" by going to Authentication -> Settings on [supabase.com/dashboard](https://supabase.com/dashboard)
|
||||
- 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 [supabase.com/dashboard](https://supabase.com/dashboard)
|
||||
@@ -148,7 +148,7 @@ functions:
|
||||
- A user can sign up either via email or OAuth.
|
||||
- If you provide `email` without a `password`, the user will be sent a magic link.
|
||||
- The magic link's destination URL is determined by the SITE_URL config variable. To change this, you can go to Authentication -> Settings on [supabase.com/dashboard](https://supabase.com/dashboard)
|
||||
- Specifying a `provider` will open the browser to the relevant login page.
|
||||
- Specifying a `provider` will open the browser to the relevant sign-in page.
|
||||
examples:
|
||||
- id: sign-in-with-email-and-password
|
||||
name: Sign in with email and password
|
||||
@@ -192,10 +192,10 @@ functions:
|
||||
- id: sign-in-using-a-third-party-provider-with-redirect
|
||||
name: Sign in using a third-party provider with redirect
|
||||
description: |
|
||||
Note that the `redirectTo` param is only relevant for OAuth logins, where the login flow is managed by
|
||||
the Auth server. If you are using email/phone logins you should set up your own redirects (within the email/sms template).
|
||||
Note that the `redirectTo` param is only relevant for OAuth sign-ins, where the sign-in flow is managed by
|
||||
the Auth server. If you are using email/phone sign-ins you should set up your own redirects (within the email/sms template).
|
||||
|
||||
Sometimes you want to control where the user is redirected to after they are logged in. Supabase supports this for
|
||||
Sometimes you want to control where the user is redirected to after they are signed in. Supabase supports this for
|
||||
any URL path on your website (the URL must either be on the same domain as your [Site URL](https://supabase.com/dashboard/project/_/auth/url-configuration) or match one of the Redirect URLs).
|
||||
|
||||
See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.
|
||||
@@ -224,7 +224,7 @@ functions:
|
||||
- id: sign-in-with-refresh-token
|
||||
name: Sign in using a refresh token (e.g. in React Native).
|
||||
description: |
|
||||
If you are completing a sign up or login in a React Native app you can pass the refresh token obtained from the provider to obtain a session.
|
||||
If you are completing a sign up or sign-in in a React Native app you can pass the refresh token obtained from the provider to obtain a session.
|
||||
code: |
|
||||
```js
|
||||
// An example using Expo's `AuthSession`
|
||||
@@ -273,7 +273,7 @@ functions:
|
||||
This method gets the user object from memory.
|
||||
examples:
|
||||
- id:
|
||||
name: Get the logged in user
|
||||
name: Get the signed-in user
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```js
|
||||
@@ -288,7 +288,7 @@ functions:
|
||||
To only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
|
||||
User metadata: It's generally better to store user data in a table within 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.
|
||||
Use the `update()` method if you have data which rarely changes or is specific only to the signed-in user.
|
||||
examples:
|
||||
- id: update-the-email-for-an-authenticated-user
|
||||
name: Update the email for an authenticated user
|
||||
@@ -737,7 +737,7 @@ functions:
|
||||
- id: passing-custom-headers
|
||||
name: Passing custom headers.
|
||||
description: |
|
||||
You can pass custom headers to your Edge Function. Note: supabase-js automatically passes the `Authorization` header with the signed in user's JWT.
|
||||
You can pass custom headers to your Edge Function. Note: supabase-js automatically passes the `Authorization` header with the signed-in user's JWT.
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```js
|
||||
|
||||
@@ -29,7 +29,7 @@ functions:
|
||||
### OAuth and OTP link verification
|
||||
|
||||
[supabase-kt](https://github.com/supabase-community/supabase-kt) provides several platform implementations for OAuth and OTP link verification. \
|
||||
**On JVM**, it uses a HTTP Callback Server to receive the session data from a successful OAuth login.
|
||||
**On JVM**, it uses a HTTP Callback Server to receive the session data from a successful OAuth sign-in.
|
||||
|
||||
*Note: OTP link verification such as sign ups are not supported on JVM. You may have to send a verification token rather than a url in your E-Mail. To send the token, rather than a redirect url, you have to change `{{ .ConfirmationURL }}` in your sign up email to `{{ .Token }}`*
|
||||
|
||||
@@ -63,7 +63,7 @@ functions:
|
||||
On Android: `supabase.handleDeeplinks(intent)` \
|
||||
On IOS/macOS: `supabase.handleDeeplinks(url)`
|
||||
|
||||
Then you can just login using OAuth:
|
||||
Then you can just sign in using OAuth:
|
||||
```kotlin
|
||||
supabase.gotrue.loginWith(Google)
|
||||
```
|
||||
@@ -140,15 +140,15 @@ functions:
|
||||
|
||||
**Desktop:**
|
||||
|
||||
`httpPort`: The port the web server is running on, when logging in with OAuth. Default: `0` (random port).
|
||||
`httpPort`: The port the web server is running on, when signing in with OAuth. Default: `0` (random port).
|
||||
|
||||
`timeout`: The timeout for the web server, when logging in with OAuth. Default: `1.minutes`.
|
||||
`timeout`: The timeout for the web server, when signing in with OAuth. Default: `1.minutes`.
|
||||
|
||||
`htmlTitle`: The title of the redirect page, when logging in with OAuth. Default: `"Supabase Auth"`.
|
||||
`htmlTitle`: The title of the redirect page, when signing in with OAuth. Default: `"Supabase Auth"`.
|
||||
|
||||
`htmlText`: The text of the redirect page, when logging in with OAuth. Default: `"Logged in. You may continue in your app."`.
|
||||
`htmlText`: The text of the redirect page, when signing in with OAuth. Default: `"Logged in. You may continue in your app."`.
|
||||
|
||||
`htmlIconUrl`: The icon of the redirect page, when logging in with OAuth. Default: `"https://supabase.com/brand-assets/supabase-logo-icon.png"`.
|
||||
`htmlIconUrl`: The icon of the redirect page, when signing in with OAuth. Default: `"https://supabase.com/brand-assets/supabase-logo-icon.png"`.
|
||||
- id: configure-postgrest
|
||||
name: Configure PostgREST module
|
||||
code: |
|
||||
@@ -2094,10 +2094,10 @@ functions:
|
||||
$ref: '@supabase/gotrue-js.GoTrueClient.signUp'
|
||||
notes: |
|
||||
Creates a new user.
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **Confirm email** determines if users need to confirm their email address after signing up.
|
||||
- If **Confirm email** is enabled, the return value is the user and you won't be logged in automatically.
|
||||
- If **Confirm email** is disabled, the return value is null and you will be logged in instead.
|
||||
- If **Confirm email** is enabled, the return value is the user and you won't be signed in automatically.
|
||||
- If **Confirm email** is disabled, the return value is null and you will be signed in instead.
|
||||
- When the user confirms their email address, they are redirected to the [`SITE_URL`](https://supabase.com/docs/guides/auth/redirect-urls) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://supabase.com/dashboard/project/_/auth/url-configuration).
|
||||
- To learn how to handle OTP links & OAuth refer to [initializing](/docs/reference/kotlin/initializing)
|
||||
- If signUpWith() is called for an existing confirmed user:
|
||||
@@ -2345,7 +2345,7 @@ functions:
|
||||
title: 'Verify OTPs'
|
||||
$ref: '@supabase/gotrue-js.GoTrueClient.verifyOtp'
|
||||
notes: |
|
||||
Log in a user given a User supplied OTP received via mobile.
|
||||
Sign in a user given a User supplied OTP received via mobile.
|
||||
examples:
|
||||
- id: verify-email-otp(otp)
|
||||
name: Verify an Email OTP
|
||||
@@ -2447,7 +2447,7 @@ functions:
|
||||
- Should be used only when you require the most current user data. For faster results, `getCurrentSessionOrNull()?.user` is recommended.
|
||||
examples:
|
||||
- id: get-the-logged-in-user-with-the-current-existing-session
|
||||
name: Get the logged in user with the current session
|
||||
name: Get the signed-in user with the current session
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```kotlin
|
||||
@@ -2570,7 +2570,7 @@ functions:
|
||||
title: 'Send a password reset request'
|
||||
notes: |
|
||||
Sends a password reset request to the given email address.
|
||||
- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.
|
||||
- The password reset flow consists of 2 broad steps: (i) Allow the user to sign in via the password reset link; (ii) Update the user's password.
|
||||
- The `sendRecoveryEmail()` only sends a password reset link to the user's email.
|
||||
To update the user's password, see [`modifyUser()`](/docs/reference/kotlin/auth-updateuser).
|
||||
- The user gets redirected back to your app, assuming you setup [OTP handling](/docs/reference/kotlin/initializing)
|
||||
@@ -2737,7 +2737,7 @@ functions:
|
||||
val enabledFlow = supabase.gotrue.mfa.isMfaEnabledFlow
|
||||
```
|
||||
- id: aal-enabled-for-current-session
|
||||
name: Check whether the user is logged in using AAL2
|
||||
name: Check whether the user is signed in using AAL2
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```kotlin
|
||||
|
||||
@@ -30,7 +30,7 @@ functions:
|
||||
|
||||
[supabase-kt](https://github.com/supabase-community/supabase-kt) provides several platform implementations for OAuth and OTP link verification.
|
||||
|
||||
**On Desktop platforms (JVM, MacOS\*, Linux)**, it uses a HTTP Callback Server to receive the session data from a successful OAuth login. The success page can be customized via `AuthConfig#httpCallbackConfig` \
|
||||
**On Desktop platforms (JVM, MacOS\*, Linux)**, it uses a HTTP Callback Server to receive the session data from a successful OAuth sign-in. The success page can be customized via `AuthConfig#httpCallbackConfig` \
|
||||
\* If no deeplinks are being used.
|
||||
|
||||
*Note: OTP link verification such as sign ups are not supported on JVM. You may have to send a verification token rather than a url in your email. To send the token, rather than a redirect url, change `{{ .ConfirmationURL }}` in your sign up email to `{{ .Token }}`*
|
||||
@@ -66,7 +66,7 @@ functions:
|
||||
If you don't want a separate activity, just call this function at the top of your `onCreate` function in your MainActivity. \
|
||||
On iOS/MacOS: `supabase.handleDeeplinks(url)`
|
||||
|
||||
Then you can log in using OAuth:
|
||||
Then you can sign in using OAuth:
|
||||
```kotlin
|
||||
supabase.auth.signInWith(Google)
|
||||
```
|
||||
@@ -182,15 +182,15 @@ functions:
|
||||
|
||||
**Desktop:**
|
||||
|
||||
`httpPort`: The port the web server is running on, when logging in with OAuth. Default: `0` (random port).
|
||||
`httpPort`: The port the web server is running on, when signing in with OAuth. Default: `0` (random port).
|
||||
|
||||
`timeout`: The timeout for the web server, when logging in with OAuth. Default: `1.minutes`.
|
||||
`timeout`: The timeout for the web server, when signing in with OAuth. Default: `1.minutes`.
|
||||
|
||||
`htmlTitle`: The title of the redirect page, when logging in with OAuth. Default: `"Supabase Auth"`.
|
||||
`htmlTitle`: The title of the redirect page, when signing in with OAuth. Default: `"Supabase Auth"`.
|
||||
|
||||
`htmlText`: The text of the redirect page, when logging in with OAuth. Default: `"Logged in. You may continue in your app."`.
|
||||
`htmlText`: The text of the redirect page, when signing in with OAuth. Default: `"Logged in. You may continue in your app."`.
|
||||
|
||||
`htmlIconUrl`: The icon of the redirect page, when logging in with OAuth. Default: `"https://supabase.com/brand-assets/supabase-logo-icon.png"`.
|
||||
`htmlIconUrl`: The icon of the redirect page, when signing in with OAuth. Default: `"https://supabase.com/brand-assets/supabase-logo-icon.png"`.
|
||||
- id: configure-postgrest
|
||||
name: Configure PostgREST module
|
||||
code: |
|
||||
@@ -2824,10 +2824,10 @@ functions:
|
||||
$ref: '@supabase/gotrue-js.GoTrueClient.signUp'
|
||||
notes: |
|
||||
Creates a new user.
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **Confirm email** determines if users need to confirm their email address after signing up.
|
||||
- If **Confirm email** is enabled, the return value is the user and you won't be logged in automatically.
|
||||
- If **Confirm email** is disabled, the return value is null and you will be logged in instead.
|
||||
- If **Confirm email** is enabled, the return value is the user and you won't be signed in automatically.
|
||||
- If **Confirm email** is disabled, the return value is null and you will be signed in instead.
|
||||
- When the user confirms their email address, they are redirected to the [`SITE_URL`](https://supabase.com/docs/guides/auth/redirect-urls) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://supabase.com/dashboard/project/_/auth/url-configuration).
|
||||
- To learn how to handle OTP links & OAuth refer to [initializing](/docs/reference/kotlin/initializing)
|
||||
- If signUpWith() is called for an existing confirmed user:
|
||||
@@ -3423,7 +3423,7 @@ functions:
|
||||
description: The JWT token.
|
||||
examples:
|
||||
- id: get-the-logged-in-user-with-the-current-existing-session
|
||||
name: Get the logged in user with the current session
|
||||
name: Get the signed-in user with the current session
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```kotlin
|
||||
@@ -3696,7 +3696,7 @@ functions:
|
||||
title: 'Send a password reset request'
|
||||
notes: |
|
||||
Sends a password reset request to the given email address.
|
||||
- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.
|
||||
- The password reset flow consists of 2 broad steps: (i) Allow the user to sign in via the password reset link; (ii) Update the user's password.
|
||||
- The `resetPasswordForEmail()` only sends a password reset link to the user's email.
|
||||
To update the user's password, see [`updateUser()`](/docs/reference/kotlin/auth-updateuser).
|
||||
- The user gets redirected back to your app, assuming you setup [OTP handling](/docs/reference/kotlin/initializing)
|
||||
@@ -3962,7 +3962,7 @@ functions:
|
||||
val statusFlow = supabase.auth.mfa.statusFlow
|
||||
```
|
||||
- id: aal-enabled-for-current-session
|
||||
name: Check whether the user is logged in using AAL2
|
||||
name: Check whether the user is signed in using AAL2
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```kotlin
|
||||
|
||||
@@ -35,7 +35,7 @@ functions:
|
||||
|
||||
The following will explain how each target handles OAuth and OTP link verification, if supported.
|
||||
|
||||
**On Desktop platforms (JVM, MacOS\*, Linux, Windows)**, it uses a HTTP Callback Server to receive the session data from a successful OAuth login. The success page can be customized via `AuthConfig#httpCallbackConfig` \
|
||||
**On Desktop platforms (JVM, MacOS\*, Linux, Windows)**, it uses a HTTP Callback Server to receive the session data from a successful OAuth sign-in. The success page can be customized via `AuthConfig#httpCallbackConfig` \
|
||||
\* If no deeplinks are being used. This works as-is, by default.
|
||||
|
||||
*Note: OTP link verification such as sign ups are not supported on JVM. You may have to send a verification token rather than a url in your email. To send the token, rather than a redirect url, change `{{ .ConfirmationURL }}` in your sign up email to `{{ .Token }}`*
|
||||
@@ -71,7 +71,7 @@ functions:
|
||||
If you don't want a separate activity, just call this function at the top of your `onCreate` function in your MainActivity. \
|
||||
On iOS/MacOS: `supabase.handleDeeplinks(url)`
|
||||
|
||||
Then you can log in using OAuth:
|
||||
Then you can sign in using OAuth:
|
||||
```kotlin
|
||||
supabase.auth.signInWith(Google)
|
||||
```
|
||||
@@ -187,15 +187,15 @@ functions:
|
||||
|
||||
**Desktop:**
|
||||
|
||||
`httpPort`: The port the web server is running on, when logging in with OAuth. Default: `0` (random port).
|
||||
`httpPort`: The port the web server is running on, when signing in with OAuth. Default: `0` (random port).
|
||||
|
||||
`timeout`: The timeout for the web server, when logging in with OAuth. Default: `1.minutes`.
|
||||
`timeout`: The timeout for the web server, when signing in with OAuth. Default: `1.minutes`.
|
||||
|
||||
`htmlTitle`: The title of the redirect page, when logging in with OAuth. Default: `"Supabase Auth"`.
|
||||
`htmlTitle`: The title of the redirect page, when signing in with OAuth. Default: `"Supabase Auth"`.
|
||||
|
||||
`htmlText`: The text of the redirect page, when logging in with OAuth. Default: `"Logged in. You may continue in your app."`.
|
||||
`htmlText`: The text of the redirect page, when signing in with OAuth. Default: `"Logged in. You may continue in your app."`.
|
||||
|
||||
`htmlIconUrl`: The icon of the redirect page, when logging in with OAuth. Default: `"https://supabase.com/brand-assets/supabase-logo-icon.png"`.
|
||||
`htmlIconUrl`: The icon of the redirect page, when signing in with OAuth. Default: `"https://supabase.com/brand-assets/supabase-logo-icon.png"`.
|
||||
- id: configure-postgrest
|
||||
name: Configure PostgREST module
|
||||
code: |
|
||||
@@ -3010,10 +3010,10 @@ functions:
|
||||
$ref: '@supabase/gotrue-js.GoTrueClient.signUp'
|
||||
notes: |
|
||||
Creates a new user.
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **Confirm email** determines if users need to confirm their email address after signing up.
|
||||
- If **Confirm email** is enabled, the return value is the user and you won't be logged in automatically.
|
||||
- If **Confirm email** is disabled, the return value is null and you will be logged in instead.
|
||||
- If **Confirm email** is enabled, the return value is the user and you won't be signed in automatically.
|
||||
- If **Confirm email** is disabled, the return value is null and you will be signed in instead.
|
||||
- When the user confirms their email address, they are redirected to the [`SITE_URL`](https://supabase.com/docs/guides/auth/redirect-urls) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://supabase.com/dashboard/project/_/auth/url-configuration).
|
||||
- To learn how to handle OTP links & OAuth refer to [initializing](/docs/reference/kotlin/initializing)
|
||||
- If signUpWith() is called for an existing confirmed user:
|
||||
@@ -3628,7 +3628,7 @@ functions:
|
||||
description: The JWT token.
|
||||
examples:
|
||||
- id: get-the-logged-in-user-with-the-current-existing-session
|
||||
name: Get the logged in user with the current session
|
||||
name: Get the signed-in user with the current session
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```kotlin
|
||||
@@ -3931,7 +3931,7 @@ functions:
|
||||
title: 'Send a password reset request'
|
||||
notes: |
|
||||
Sends a password reset request to the given email address.
|
||||
- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.
|
||||
- The password reset flow consists of 2 broad steps: (i) Allow the user to sign in via the password reset link; (ii) Update the user's password.
|
||||
- The `resetPasswordForEmail()` only sends a password reset link to the user's email.
|
||||
To update the user's password, see [`updateUser()`](/docs/reference/kotlin/auth-updateuser).
|
||||
- The user gets redirected back to your app, assuming you setup [OTP handling](/docs/reference/kotlin/initializing)
|
||||
@@ -4197,7 +4197,7 @@ functions:
|
||||
val statusFlow = supabase.auth.mfa.statusFlow
|
||||
```
|
||||
- id: aal-enabled-for-current-session
|
||||
name: Check whether the user is logged in using AAL2
|
||||
name: Check whether the user is signed in using AAL2
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```kotlin
|
||||
|
||||
@@ -52,11 +52,11 @@ functions:
|
||||
- name: persist_session
|
||||
isOptional: true
|
||||
type: bool
|
||||
description: Whether to persist a logged in session to storage.
|
||||
description: Whether to persist a signed-in session to storage.
|
||||
- name: storage
|
||||
isOptional: true
|
||||
type: SyncSupportedStorage
|
||||
description: A storage provider. Used to store the logged in session.
|
||||
description: A storage provider. Used to store the signed-in session.
|
||||
- name: realtime
|
||||
isOptional: true
|
||||
type: string
|
||||
@@ -157,7 +157,7 @@ functions:
|
||||
The channel to use for sending messages.
|
||||
Only for phone signups.
|
||||
notes: |
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](https://supabase.com/dashboard/project/_/auth/providers).
|
||||
- **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.
|
||||
@@ -165,7 +165,7 @@ functions:
|
||||
- If sign_up() is called for an existing confirmed user:
|
||||
- When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.
|
||||
- When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, `User already registered` is returned.
|
||||
- To fetch the currently logged-in user, refer to [`get_user()`](/docs/reference/python/auth-getuser).
|
||||
- To fetch the currently signed-in user, refer to [`get_user()`](/docs/reference/python/auth-getuser).
|
||||
examples:
|
||||
- id: signup
|
||||
name: Sign up with an email and password
|
||||
@@ -457,7 +457,7 @@ functions:
|
||||
isOptional: true
|
||||
type: string
|
||||
notes: |
|
||||
Log in an existing user with an email and password or phone and password.
|
||||
Sign in an existing user with an email and password or phone and password.
|
||||
- Requires either an email and password or a phone number and password.
|
||||
examples:
|
||||
- id: sign-in-with-email-and-password
|
||||
@@ -1235,7 +1235,7 @@ functions:
|
||||
- The User model includes the following fields (since v2.28.0): `is_sso_user` (bool, defaults to `False`), `deleted_at` (optional string), and `banned_until` (optional string) in addition to the existing fields.
|
||||
examples:
|
||||
- id: get-the-logged-in-user-with-the-current-existing-session
|
||||
name: Get the logged in user with the current existing session
|
||||
name: Get the signed-in user with the current existing session
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```
|
||||
@@ -1275,7 +1275,7 @@ functions:
|
||||
}
|
||||
```
|
||||
- id: get-the-logged-in-user-with-a-custom-access-token-jwt
|
||||
name: Get the logged in user with a custom access token jwt
|
||||
name: Get the signed-in user with a custom access token jwt
|
||||
isSpotlight: false
|
||||
code: |
|
||||
```
|
||||
@@ -1861,7 +1861,7 @@ functions:
|
||||
isOptional: false
|
||||
type: string
|
||||
notes: |
|
||||
Log in an existing user by exchanging an Auth Code issued during the PKCE flow.
|
||||
Sign in an existing user by exchanging an Auth Code issued during the PKCE flow.
|
||||
|
||||
- Used when `flow_type` is set to `pkce` in client options.
|
||||
examples:
|
||||
@@ -3088,7 +3088,7 @@ functions:
|
||||
type: string
|
||||
description: Verification token received when the user completes the captcha on the site.
|
||||
notes: |
|
||||
- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.
|
||||
- The password reset flow consists of 2 broad steps: (i) Allow the user to sign in via the password reset link; (ii) Update the user's password.
|
||||
- The `reset_password_for_email()` only sends a password reset link to the user's email.
|
||||
To update the user's password, see [`update_user()`](/docs/reference/python/auth-updateuser).
|
||||
- When the user clicks the reset link in the email they are redirected back to your application.
|
||||
@@ -7320,7 +7320,7 @@ functions:
|
||||
description: |
|
||||
The library accepts custom headers via the `headers` option.
|
||||
|
||||
Note: `supabase-py` automatically populates the `Authorization` header if there is a signed in user.
|
||||
Note: `supabase-py` automatically populates the `Authorization` header if there is a signed-in user.
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```python
|
||||
|
||||
@@ -81,7 +81,7 @@ functions:
|
||||
- id: sign-up
|
||||
title: 'signUp()'
|
||||
notes: |
|
||||
- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).
|
||||
- By default, the user needs to verify their email address before signing in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).
|
||||
- **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.
|
||||
@@ -89,7 +89,7 @@ functions:
|
||||
- If signUp() is called for an existing confirmed user:
|
||||
- If **Confirm email** is enabled in [your project](/dashboard/project/_/auth/providers), 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/swift/get-user).
|
||||
- To fetch the currently signed-in user, refer to [`getUser()`](/docs/reference/swift/get-user).
|
||||
examples:
|
||||
- id: sign-up
|
||||
name: Sign up
|
||||
@@ -165,7 +165,7 @@ functions:
|
||||
title: 'signInWithOTP()'
|
||||
notes: |
|
||||
- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.
|
||||
- If the user doesn't exist, `signInWithOTP()` will signup the user instead. To restrict this behavior, you can set `shouldCreateUser` to `false`.
|
||||
- If the user doesn't exist, `signInWithOTP()` will sign up the user instead. To restrict this behavior, you can set `shouldCreateUser` to `false`.
|
||||
- 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`](/docs/guides/auth/redirect-urls).
|
||||
@@ -327,14 +327,14 @@ functions:
|
||||
- Should be used only when you require the most current user data. For faster results, `session.user` is recommended.
|
||||
examples:
|
||||
- id: get-the-logged-in-user-with-the-current-existing-session
|
||||
name: Get the logged in user with the current existing session
|
||||
name: Get the signed-in user with the current existing session
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```swift
|
||||
let user = try await supabase.auth.user()
|
||||
```
|
||||
- id: get-the-logged-in-user-with-a-custom-access-token-jwt
|
||||
name: Get the logged in user with a custom access token jwt
|
||||
name: Get the signed-in user with a custom access token jwt
|
||||
isSpotlight: false
|
||||
code: |
|
||||
```swift
|
||||
@@ -2731,7 +2731,7 @@ functions:
|
||||
- id: passing-custom-headers
|
||||
name: Passing custom headers
|
||||
description: |
|
||||
You can pass custom headers to your function. Note: supabase-js automatically passes the `Authorization` header with the signed in user's JWT.
|
||||
You can pass custom headers to your function. Note: supabase-swift automatically passes the `Authorization` header with the signed-in user's JWT.
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```swift
|
||||
|
||||
@@ -224,7 +224,7 @@ functions:
|
||||
- If signUp() is called for an existing confirmed user:
|
||||
- When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.
|
||||
- When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, `User already registered` is returned.
|
||||
- To fetch the currently logged-in user, refer to [`getUser()`](/docs/reference/swift/get-user).
|
||||
- To fetch the currently signed-in user, refer to [`getUser()`](/docs/reference/swift/get-user).
|
||||
overwriteParams:
|
||||
- name: email
|
||||
isOptional: true
|
||||
@@ -335,7 +335,7 @@ functions:
|
||||
- Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.
|
||||
- Use this to clean up any local storage your application has associated with the user.
|
||||
- `TOKEN_REFRESHED`
|
||||
- Emitted each time a new access and refresh token are fetched for the signed in user.
|
||||
- Emitted each time a new access and refresh token are fetched for the signed-in user.
|
||||
- It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.
|
||||
- Avoid frequent calls to `supabase.auth.session` for the same purpose.
|
||||
- There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.
|
||||
@@ -4741,7 +4741,7 @@ functions:
|
||||
- id: passing-custom-headers
|
||||
name: Passing custom headers
|
||||
description: |
|
||||
You can pass custom headers to your function. Note: supabase-js automatically passes the `Authorization` header with the signed in user's JWT.
|
||||
You can pass custom headers to your function. Note: supabase-swift automatically passes the `Authorization` header with the signed-in user's JWT.
|
||||
isSpotlight: true
|
||||
code: |
|
||||
```swift
|
||||
|
||||
Reference in new issue
Block a user