errors
AccessDenied
Thrown when the execution of the signIn
callback fails
or if it returns false
.
Extends
Constructors
new AccessDenied(message, errorOptions)
new AccessDenied(message?, errorOptions?): AccessDenied
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "AccessDenied";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
AccountNotLinked
Thrown when an Email address is already associated with an account but the user is trying an account that is not linked to it.
For security reasons, Auth.js does not automatically link accounts to existing accounts if the user is not signed in.
Extends
Constructors
new AccountNotLinked(message, errorOptions)
new AccountNotLinked(message?, errorOptions?): AccountNotLinked
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
kind
static kind: string = "signIn";
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "AccountNotLinked";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
AdapterError
One of the database Adapter
methods
failed during execution.
Extends
Constructors
new AdapterError(message, errorOptions)
new AdapterError(message?, errorOptions?): AdapterError
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "AdapterError";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
AuthError
Base error class for all Auth.js errors.
It’s optimized to be printed in the server logs in a nicely formatted way
via the logger.error
option.
Extends
Constructors
new AuthError(message, errorOptions)
new AuthError(message?, errorOptions?): AuthError
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Overrides
Error.constructor
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Overrides
Error.cause
message
message: string;
Inherited from
Error.message
name
name: string;
Inherited from
Error.name
stack?
optional stack: string;
Inherited from
Error.stack
type
type: ErrorType;
The error type. Used to identify the error in the logs.
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
Error.prepareStackTrace
stackTraceLimit
static stackTraceLimit: number;
Inherited from
Error.stackTraceLimit
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
Error.captureStackTrace
CallbackRouteError
This error occurs when the user cannot finish login. Depending on the provider type, this could have happened for multiple reasons.
For an OAuth provider, possible causes are:
- The user denied access to the application
- There was an error parsing the OAuth Profile:
Check out the provider’s
profile
oruserinfo.request
method to make sure it correctly fetches the user’s profile. - The
signIn
orjwt
callback methods threw an uncaught error: Check the callback method implementations.
For an Email provider, possible causes are:
- The provided email/token combination was invalid/missing:
Check if the provider’s
sendVerificationRequest
method correctly sends the email. - The provided email/token combination has expired: Ask the user to log in again.
- There was an error with the database: Check the database logs.
For a Credentials provider, possible causes are:
- The
authorize
method threw an uncaught error: Check the provider’sauthorize
method. - The
signIn
orjwt
callback methods threw an uncaught error: Check the callback method implementations.
Check out [auth][cause]
in the error message for more details.
It will show the original stack trace.
Extends
Constructors
new CallbackRouteError(message, errorOptions)
new CallbackRouteError(message?, errorOptions?): CallbackRouteError
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "CallbackRouteError";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
CredentialsSignin
Can be thrown from the authorize
callback of the Credentials provider.
When an error occurs during the authorize
callback, two things can happen:
- The user is redirected to the signin page, with
error=CredentialsSignin&code=credentials
in the URL.code
is configurable. - If you throw this error in a framework that handles form actions server-side, this error is thrown, instead of redirecting the user, so you’ll need to handle.
Extends
Constructors
new CredentialsSignin(message, errorOptions)
new CredentialsSignin(message?, errorOptions?): CredentialsSignin
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
code
code: string = "credentials";
The error code that is set in the code
query parameter of the redirect URL.
⚠ NOTE: This property is going to be included in the URL, so make sure it does not hint at sensitive errors.
The full error is always logged on the server, if you need to debug.
Generally, we don’t recommend hinting specifically if the user had either a wrong username or password specifically, try rather something like “Invalid credentials”.
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
kind
static kind: string = "signIn";
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "CredentialsSignin";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
DuplicateConditionalUI
Thrown when multiple providers have enableConditionalUI
set to true
.
Only one provider can have this option enabled at a time.
Extends
Constructors
new DuplicateConditionalUI(message, errorOptions)
new DuplicateConditionalUI(message?, errorOptions?): DuplicateConditionalUI
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "DuplicateConditionalUI";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
EmailSignInError
Happens when the login by an Email provider could not be started.
Possible causes are:
- The email sent from the client is invalid, could not be normalized by
EmailConfig.normalizeIdentifier
- The provided email/token combination has expired: Ask the user to log in again.
- There was an error with the database: Check the database logs.
Extends
Constructors
new EmailSignInError(message, errorOptions)
new EmailSignInError(message?, errorOptions?): EmailSignInError
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
kind
static kind: string = "signIn";
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "EmailSignInError";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
ErrorPageLoop
Thrown when Auth.js is misconfigured and accidentally tried to require authentication on a custom error page. To prevent an infinite loop, Auth.js will instead render its default error page.
To fix this, make sure that the error
page does not require authentication.
Learn more at Guide: Error pages
Extends
Constructors
new ErrorPageLoop(message, errorOptions)
new ErrorPageLoop(message?, errorOptions?): ErrorPageLoop
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "ErrorPageLoop";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
EventError
One of the events
methods
failed during execution.
Make sure that the events
methods are implemented correctly and uncaught errors are handled.
Learn more at events
Extends
Constructors
new EventError(message, errorOptions)
new EventError(message?, errorOptions?): EventError
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "EventError";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
ExperimentalFeatureNotEnabled
Thrown when an experimental feature is used but not enabled.
Extends
Constructors
new ExperimentalFeatureNotEnabled(message, errorOptions)
new ExperimentalFeatureNotEnabled(message?, errorOptions?): ExperimentalFeatureNotEnabled
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "ExperimentalFeatureNotEnabled";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
InvalidCallbackUrl
Thrown when Auth.js is unable to verify a callbackUrl
value.
The browser either disabled cookies or the callbackUrl
is not a valid URL.
Somebody might have tried to manipulate the callback URL that Auth.js uses to redirect the user back to the configured callbackUrl
/page.
This could be a malicious hacker trying to redirect the user to a phishing site.
To prevent this, Auth.js checks if the callback URL is valid and throws this error if it is not.
There is no action required, but it might be an indicator that somebody is trying to attack your application.
Extends
Constructors
new InvalidCallbackUrl(message, errorOptions)
new InvalidCallbackUrl(message?, errorOptions?): InvalidCallbackUrl
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "InvalidCallbackUrl";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
InvalidCheck
Thrown when a PKCE, state or nonce OAuth check could not be performed. This could happen if the OAuth provider is configured incorrectly or if the browser is blocking cookies.
Learn more at checks
Extends
Constructors
new InvalidCheck(message, errorOptions)
new InvalidCheck(message?, errorOptions?): InvalidCheck
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
optional err: Error;
Inherited from
message
message: string;
Inherited from
name
name: string;
Inherited from
stack?
optional stack: string;
Inherited from
type
type: ErrorType;
The error type. Used to identify the error in the logs.
Inherited from
prepareStackTrace()?
static optional prepareStackTrace: (err, stackTraces) => any;
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Parameter | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
stackTraceLimit
static stackTraceLimit: number;
Inherited from
type
static type: string = "InvalidCheck";
Methods
captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
Parameter | Type |
---|---|
targetObject | object |
constructorOpt ? | Function |
Returns
void
Inherited from
InvalidEndpoints
One of the configured OAuth or OIDC providers is missing the authorization
, token
or userinfo
, or issuer
configuration.
To perform OAuth or OIDC sign in, at least one of these endpoints is required.
Learn more at OAuth2Config
or Guide: OAuth Provider
Extends
Constructors
new InvalidEndpoints(message, errorOptions)
new InvalidEndpoints(message?, errorOptions?): InvalidEndpoints
Parameters
Parameter | Type |
---|---|
message ? | string | ErrorOptions |
errorOptions ? | ErrorOptions |
Returns
Inherited from
Properties
cause?
optional cause: Record<string, unknown> & {
err: Error;
};
Type declaration
err?
<