Error returned directly from the GoTrue REST API.

Base error thrown by Supabase Auth helpers.

Error thrown when implicit grant redirects contain an error.

Error thrown when email/password credentials are invalid.

Error thrown when a JWT cannot be verified or parsed.

Error thrown when the token response is malformed.

Error thrown during PKCE code exchanges.

Error thrown when a transient fetch issue occurs.

Error thrown when an operation requires a session but none is present.

Wraps non-standard errors so callers can inspect the root cause.

Error thrown when a supplied password is considered weak.

Flexible error class used to create named auth errors at runtime.

Base error for Supabase Edge Function invocations.

Error thrown when the network request to an Edge Function fails.

Error thrown when the Edge Function returns a non-2xx status code.

Error thrown when the Supabase relay cannot reach the Edge Function.

Error thrown when the browser Navigator Lock API fails to acquire a lock.

Error format

A channel is the basic building block of Realtime and narrows the scope of data flow to subscribed clients. You can think of a channel as a chatroom where participants are able to see who's online and send and receive messages.

Supabase Client.

Utilities for creating WebSocket instances across runtimes.

Creates a new Supabase Client.

Implements a global exclusive lock using the Navigator LockManager API. It is available on all browsers released after 2022-03-15 with Safari being the last one to release support. If the API is not available, this function will throw. Make sure you check availablility before configuring GoTrueClient.

Implements a global exclusive lock that works only in the current process. Useful for environments like React Native or other non-browser single-process (i.e. no concept of "tabs") environments.

An authentication methord reference (AMR) entry.

Contains all OAuth 2.1 authorization server user-facing methods. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Contains the full multi-factor authentication administration API.

Contains all OAuth client administration methods. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Contains the full multi-factor authentication API.

JWT Payload containing claims for Supabase authentication tokens.

Minimal WebSocket constructor interface that RealtimeClient can work with. Supply a compatible implementation (native WebSocket, ws, etc) when running outside the browser.

Response type for WebAuthn MFA challenge. Contains credential creation or request options from the server.

JSON-serializable version of WebAuthn challenge response. Used for server communication with base64url-encoded binary fields.

Server response type for WebAuthn MFA challenge. Contains JSON-formatted WebAuthn options ready for browser API.

Response type for WebAuthn factor enrollment. Returns the enrolled factor ID and metadata.

response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all

Response type for MFA verification operations. Returns session tokens on successful verification.

Data returned after successful MFA verification. Contains new session tokens and updated user information.

Response type for getting OAuth authorization details. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Response type for OAuth consent decision (approve/deny). Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Response type for listing user's OAuth grants. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Response type for revoking an OAuth grant. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

AuthOtpResponse is returned when OTP is used.

Parameters for creating a new OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

A MFA factor.

Type of factor. totp and phone supported with this version

The properties related to the email link generated

Provide your own global lock implementation instead of the default implementation. The function should acquire a lock for the duration of the fn async function, such that no other client instances will be able to hold it at the same time.

Parameters for initiating a WebAuthn MFA challenge. Includes Relying Party information needed for WebAuthn ceremonies.

Parameters for enrolling a WebAuthn factor. Creates an unverified WebAuthn factor that must be verified with a credential.

WebAuthn-specific fields for MFA verification. Supports both credential creation (registration) and request (authentication) flows.

Parameters for WebAuthn MFA verification. Used to verify WebAuthn credentials after challenge.

OAuth client details in an authorization request. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuth authorization details for the consent flow. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuth client object returned from the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuth client grant types supported by the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Response type for listing OAuth clients. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuth client registration type. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Response type for OAuth client operations. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuth client response types supported by the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

OAuth client type indicating whether the client can keep credentials confidential. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

An OAuth grant representing a user's authorization of an OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

Resolve mapped types and show the derived keys and their types when hovering in VS Code, instead of just showing the names those mapped types are defined with.

One of the providers supported by GoTrue.

Helper types for query results.

a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType

similar to RequestResult except it allows you to destructure the possible shape of the success response {@see RequestResult}

A stricter version of TypeScript's Omit that only allows omitting keys that actually exist. This prevents typos and ensures type safety at compile time. Unlike regular Omit, this will error if you try to omit a non-existent key.

Parameters for updating an existing OAuth client. All fields are optional. Only provided fields will be updated. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.