Error codes
Supabase Auth can throw or return various errors when using the API. All errors originating from the supabase.auth namespace of the JavaScript client library will be wrapped by the AuthError class.
Error objects are split in a few classes:
AuthApiError-- errors which originate from the Supabase Auth API.- Use
isAuthApiErrorinstead ofinstanceofchecks to see if an error you caught is of this type.
- Use
CustomAuthError-- errors which generally originate from state in the client library.- Use the
nameproperty on the error to identify the class of error received.
- Use the
Errors originating from the server API classed as AuthApiError always have a code property that can be used to identify the error returned by the server. The status property is also present, encoding the HTTP status code received in the response.
In general the HTTP status codes you will likely receive are:
- 403 Forbidden is sent out in rare situations where a certain Auth feature is not available for the user, and you as the developer are not checking a precondition whether that API is available for the user.
- 422 Unprocessable Entity is sent out when the API request is accepted, but cannot be processed because the user or Auth server is in a state where it cannot satisfy the request.
- 429 Too Many Requests is sent out when rate-limits are breached for an API. You should handle this status code often, especially in functions that authenticate a user.
- 500 Internal Server Error often means that the Auth server's service is degraded. Most often it points to issues in your database setup such as a misbehaving trigger on a schema, function, view or other database object.
- 501 Not Implemented is sent out when a feature is not enabled on the Auth server, and you are trying to use an API which requires it.
To supplement HTTP status codes, Supabase Auth returns a string error code which gives you more insight into what went wrong. These codes are stable and can be used to present an internationalized message to your users.
| Code | Description |
|---|---|
bad_code_verifier | Returned from the PKCE flow where the provided code verifier does not match the expected one. Indicates a bug in the implementation of the client library. |
bad_json | Usually used when the HTTP body of the request is not valid JSON. |
bad_jwt | JWT sent in the Authorization header is not valid. |
bad_oauth_callback | OAuth callback from provider to Auth does not have all the required attributes (state). Indicates an issue with the OAuth provider or client library implementation. |
bad_oauth_state | OAuth state (data echoed back by the OAuth provider to Supabase Auth) is not in the correct format. Indicates an issue with the OAuth provider integration. |
captcha_failed | Captcha challenge could not be verified with the captcha provider. Check your captcha integration. |
conflict | General database conflict, such as concurrent requests on resources that should not be modified concurrently. Can often occur when you have too many session refresh requests firing off at the same time for a user. Check your app for concurrency issues, and if detected back off exponentially. |
email_conflict_identity_not_deletable | Unlinking this identity causes the user's account to change to an email address which is already used by another user account. Indicates an issue where the user has two different accounts using different primary email addresses. You may need to migrate user data to one of their accounts in this case. |
email_exists | Email address already exists in the system. |
email_not_confirmed | Signing in is not allowed for this user as the email address is not confirmed. |
email_provider_disabled | Signups are disabled for email and password. |
flow_state_expired | PKCE flow state to which the API request relates has expired. Ask the user to sign in again. |
flow_state_not_found | PKCE flow state to which the API request relates no longer exists. Flow states expire after a while and are progressively cleaned up, which can cause this error. Retried requests can cause this error, as the previous request likely destroyed the flow state. Ask the user to sign in again. |
identity_already_exists | The identity to which the API relates is already linked to a user. |
identity_not_found | Identity to which the API call relates does not exist, such as when an identity is unlinked or deleted. |
insufficient_aal | To call this API, the user must have a higher Authenticator Assurance Level. To resolve, ask the user to solve an MFA challenge. |
invite_not_found | Invite is expired or already used. |
manual_linking_disabled | Calling the supabase.auth.linkUser() and related APIs is not enabled on the Auth server. |
mfa_challenge_expired | Responding to an MFA challenge should happen within a fixed time period. Request a new challenge when encountering this error. |
mfa_factor_name_conflict | MFA factors for a single user should not have the same friendly name. |
mfa_factor_not_found | MFA factor no longer exists. |
mfa_ip_address_mismatch | The enrollment process for MFA factors must begin and end with the same IP address. |
mfa_verification_failed | MFA challenge could not be verified -- wrong TOTP code. |
mfa_verification_rejected | Further MFA verification is rejected. Only returned if the MFA verification attempt hook returns a reject decision. |
no_authorization | This HTTP request requires an Authorization header, which is not provided. |
not_admin | User accessing the API is not admin, i.e. the JWT does not contain a role claim that identifies them as an admin of the Auth server. |
oauth_provider_not_supported | Using an OAuth provider which is disabled on the Auth server. |
otp_disabled | Sign in with OTPs (magic link, email OTP) is disabled. Check your sever's configuration. |
otp_expired | OTP code for this sign-in has expired. Ask the user to sign in again. |
over_email_send_rate_limit | Too many emails have been sent to this email address. Ask the user to wait a while before trying again. |
over_request_rate_limit | Too many requests have been sent by this client (IP address). Ask the user to try again in a few minutes. Sometimes can indicate a bug in your application that mistakenly sends out too many requests (such as a badly written useEffect React hook). |
over_sms_send_rate_limit | Too many SMS messages have been sent to this phone number. Ask the user to wait a while before trying again. |
phone_exists | Phone number already exists in the system. |
phone_not_confirmed | Signing in is not allowed for this user as the phone number is not confirmed. |
phone_provider_disabled | Signups are disabled for phone and password. |
provider_disabled | OAuth provider is disabled for use. Check your server's configuration. |
provider_email_needs_verification | Not all OAuth providers verify their user's email address. Supabase Auth requires emails to be verified, so this error is sent out when a verification email is sent after completing the OAuth flow. |
reauthentication_needed | A user needs to reauthenticate to change their password. Ask the user to reauthenticate by calling the supabase.auth.reauthenticate() API. |
reauthentication_not_valid | Verifying a reauthentication failed, the code is incorrect. Ask the user to enter a new code. |
same_password | A user that is updating their password must use a different password than the one currently used. |
saml_assertion_no_email | SAML assertion (user information) was received after sign in, but no email address was found in it which is required. Check the provider's attribute mapping and/or configuration. |
saml_assertion_no_user_id | SAML assertion (user information) was received after sign in, but a user ID (called NameID) was not found in it which is required. Check the SAML identity provider's configuration. |
saml_entity_id_mismatch | (Admin API.) Updating the SAML metadata for a SAML identity provider is not possible, as the entity ID in the update does not match the entity ID in the database. This is equivalent to creating a new identity provider, and you should do that instead. |
saml_idp_already_exists | (Admin API.) Adding a SAML identity provider that is already added. |
saml_idp_not_found | SAML identity provider not found. Most often returned after IdP-initiated sign-in with an unregistered SAML identity provider in Supabase Auth. |
saml_metadata_fetch_failed | (Admin API.) Adding or updating a SAML provider failed as its metadata could not be fetched from the provided URL. |
saml_provider_disabled | Using Enterprise SSO with SAML 2.0 is not enabled on the Auth server. |
saml_relay_state_expired | SAML relay state is an object that tracks the progress of a supabase.auth.signInWithSSO() request. The SAML identity provider should respond after a fixed amount of time, after which this error is shown. Ask the user to sign in again. |
saml_relay_state_not_found | SAML relay states are progressively cleaned up after they expire, which can cause this error. Ask the user to sign in again. |
session_not_found | Session to which the API request relates no longer exists. This can occur if the user has signed out, or the session entry in the database was deleted in some other way. |
signup_disabled | Sign ups (new account creation) is disabled on the server. |
single_identity_not_deletable | Every user must have at least one identity attached to it, so deleting (unlinking) an identity is not allowed if it's the only one for the user. |
sms_send_failed | Sending an SMS message failed. Check your SMS provider configuration. |
sso_domain_already_exists | (Admin API.) Only one SSO domain can be registered per SSO identity provider. |
sso_provider_not_found | SSO provider not found. Check the arguments in supabase.auth.signInWithSSO(). |
too_many_enrolled_mfa_factors | A user can only have a fixed number of enrolled MFA factors. |
unexpected_audience | (Deprecated feature not available via Supabase JavaScript client.) The request's X-JWT-AUD claim does not match the JWT's audience. |
unexpected_failure | Auth service is degraded or a bug is present, without a specific reason. |
user_already_exists | User with this information (email address, phone number) cannot be created again as it already exists. |
user_banned | User to which the API request relates has a banned_until property which is still active. No further API requests should be attempted until this field is cleared. |
user_not_found | User to which the API request relates no longer exists. |
user_sso_managed | When a user comes from SSO, certain fields of the user cannot be updated (like email). |
validation_failed | Provided parameters are not in the expected format. |
weak_password | User is signing up or changing their password without meeting the password strength criteria. Use the AuthWeakPasswordError class to access more information about what they need to do to make the assword pass. |
Tips for better error handling
- Do not use string matching on error messages! Always use the
nameandcodeproperties of error objects to identify the situation. - Although HTTP status codes generally don't change, they can suddenly change due to bugs, so avoid relying on them unless absolutely necessary.