Skip to content

Latest commit

 

History

History
169 lines (90 loc) · 6.33 KB

errors.md

File metadata and controls

169 lines (90 loc) · 6.33 KB
id title
errors
Errors

This is a list of errors output from NextAuth.js.

All errors indicate an unexpected problem, you should not expect to see errors.

If you are seeing any of these errors in the console, something is wrong.


Client

These errors are returned from the client. As the client is Universal JavaScript (or "Isomorphic JavaScript") it can be run on the client or server, so these errors can occur both in the terminal and in the browser console.

CLIENT_SESSION_ERROR

This error occurs when the SessionProvider Context has a problem fetching session data.

CLIENT_FETCH_ERROR

If you see CLIENT_FETCH_ERROR make sure you have configured the NEXTAUTH_URL environment variable.


Server

These errors are displayed on the terminal.

OAuth

OAUTH_GET_ACCESS_TOKEN_ERROR

This occurs when there was an error in the POST request to the OAuth provider and we were not able to retrieve the access token.

Please double check your provider settings.

OAUTH_V1_GET_ACCESS_TOKEN_ERROR

This error is explicitly related to older OAuth v1.x providers, if you are using one of these, please double check all available settings.

OAUTH_GET_PROFILE_ERROR

N/A

OAUTH_PARSE_PROFILE_ERROR

This error is a result of either a problem with the provider response or the user canceling the action with the provider, unfortunately, we can't discern which with the information we have.

This error should also log the exception and available profileData to further aid debugging.

OAUTH_CALLBACK_HANDLER_ERROR

This error will occur when there was an issue parsing the JSON request body, for example.

There should also be further details logged when this occurs, such as the error is thrown, and the request body itself to aid in debugging.


Signin / Callback

SIGNIN_OAUTH_ERROR

This error occurs during the redirection to the authorization URL of the OAuth provider. Possible causes:

  1. Cookie handling Either PKCE code verifier or the generation of the CSRF token hash in the internal state failed.

If set, check your cookies configuration, and make sure the browser is not blocking/restricting cookies.

  1. OAuth misconfiguration

Please check your OAuth provider and make sure your URLs and other options are correctly set.

If you are using an OAuth v1 provider, check your OAuth v1 provider settings, especially the OAuth token and OAuth token secret.

CALLBACK_OAUTH_ERROR

This can occur during the handling of the callback if the code_verifier cookie was not found or an invalid state was returned from the OAuth provider.

SIGNIN_EMAIL_ERROR

This error can occur when a user tries to sign in via an email link; for example, if the email token could not be generated or the verification request failed.

Please double check your email settings.

CALLBACK_EMAIL_ERROR

This can occur during the email callback process. Specifically, if there was an error signing the user in via email, encoding the jwt, etc.

Please double check your Email settings.

EMAIL_REQUIRES_ADAPTER_ERROR

The Email authentication provider can only be used if a database is configured.

This is required to store the verification token. Please see the email provider for more details.

CALLBACK_CREDENTIALS_JWT_ERROR

The Credentials Provider can only be used if JSON Web Tokens are used for sessions.

JSON Web Tokens are used for Sessions by default if you have not specified a database. However, if you are using a database, then Database Sessions are enabled by default and you need to explicitly enable JWT Sessions to use the Credentials Provider.

If you are using a Credentials Provider, NextAuth.js will not persist users or sessions in a database - user accounts used with the Credentials Provider must be created and managed outside of NextAuth.js.

In most cases it does not make sense to specify a database in NextAuth.js options and support a Credentials Provider.

CALLBACK_CREDENTIALS_HANDLER_ERROR

This error occurs when there was no authorize() handler defined on the credential authentication provider.

PKCE_ERROR

The provider you tried to use failed when setting PKCE or Proof Key for Code Exchange. The code_verifier is saved in a cookie called (by default) __Secure-next-auth.pkce.code_verifier which expires after 15 minutes. Check if cookies.pkceCodeVerifier is configured correctly.

The default code_challenge_method is "S256". This is currently not configurable to "plain", as per RFC7636:

If the client is capable of using "S256", it MUST use "S256", as S256" is Mandatory To Implement (MTI) on the server.

INVALID_CALLBACK_URL_ERROR

The callbackUrl provided was either invalid or not defined. See specifying a callbackUrl for more information.


Session Handling

JWT_SESSION_ERROR

JWKKeySupport: the key does not support HS512 verify algorithm

The algorithm used for generating your key isn't listed as supported. You can generate a HS512 key using

  jose newkey -s 512 -t oct -a HS512

SESSION_ERROR


Signout

SIGNOUT_ERROR

This error occurs when there was an issue deleting the session from the database, for example.


Other

MISSING_NEXTAUTH_API_ROUTE_ERROR

This error happens when [...nextauth].js file is not found inside pages/api/auth.

Make sure the file is there and the filename is written correctly.

NO_SECRET

In production, we expect you to define a secret property in your configuration. In development, this is shown as a warning for convenience. Read more

oauth_callback_error expected 200 OK with body but no body was returned

This error might happen with some of the providers. It happens due to openid-client(which is peer dependency) node version mismatch. For instance, openid-client requires >=14.2.0 for lts/fermium and has similar limits for the other versions. For the full list of the compatible node versions please see package.json