Readonlymfa
+ Thrown when network requests to the Auth server fail.
Error thrown when initiating an MFA challenge fails.
+try {
const challenge = await mfa.challenge({
mfaToken: mfaToken,
challengeType: 'otp',
authenticatorId: 'otp|dev_123'
});
} catch (error) {
if (error instanceof MfaChallengeError) {
console.log(error.error); // 'too_many_attempts'
console.log(error.error_description); // 'Rate limit exceeded'
}
}
+Optionalstack
+ Staticstack
+ The Error.stackTraceLimit property specifies the
+ number of stack frames collected by a stack trace (whether
+ generated by new Error().stack or
+ Error.captureStackTrace(obj)).
+
+ The default value is 10 but may be set to any
+ valid JavaScript number. Changes will affect any stack trace
+ captured after the value has been changed.
+
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+Staticcapture
+ Creates a .stack property on
+ targetObject, which when accessed returns a
+ string representing the location in the code at which
+ Error.captureStackTrace() was called.
+
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
+
+ The first line of the trace will be prefixed with
+ ${myObject.name}: ${myObject.message}.
+
+ The optional constructorOpt argument
+ accepts a function. If given, all frames above
+ constructorOpt, including
+ constructorOpt, will be omitted from the
+ generated stack trace.
+
+ The constructorOpt argument is useful for
+ hiding implementation details of error generation from
+ the user. For instance:
+
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
+OptionalconstructorOpt:
+ Function
+ StaticfromStaticprepare+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
+Error thrown when enrolling an MFA authenticator fails.
+Optionalstack
+ Staticstack
+ The Error.stackTraceLimit property specifies the
+ number of stack frames collected by a stack trace (whether
+ generated by new Error().stack or
+ Error.captureStackTrace(obj)).
+
+ The default value is 10 but may be set to any
+ valid JavaScript number. Changes will affect any stack trace
+ captured after the value has been changed.
+
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+Staticcapture
+ Creates a .stack property on
+ targetObject, which when accessed returns a
+ string representing the location in the code at which
+ Error.captureStackTrace() was called.
+
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
+
+ The first line of the trace will be prefixed with
+ ${myObject.name}: ${myObject.message}.
+
+ The optional constructorOpt argument
+ accepts a function. If given, all frames above
+ constructorOpt, including
+ constructorOpt, will be omitted from the
+ generated stack trace.
+
+ The constructorOpt argument is useful for
+ hiding implementation details of error generation from
+ the user. For instance:
+
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
+OptionalconstructorOpt:
+ Function
+ StaticfromStaticprepare+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
+Error thrown when getting enrollment factors fails.
+Optionalstack
+ Staticstack
+ The Error.stackTraceLimit property specifies the
+ number of stack frames collected by a stack trace (whether
+ generated by new Error().stack or
+ Error.captureStackTrace(obj)).
+
+ The default value is 10 but may be set to any
+ valid JavaScript number. Changes will affect any stack trace
+ captured after the value has been changed.
+
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+Staticcapture
+ Creates a .stack property on
+ targetObject, which when accessed returns a
+ string representing the location in the code at which
+ Error.captureStackTrace() was called.
+
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
+
+ The first line of the trace will be prefixed with
+ ${myObject.name}: ${myObject.message}.
+
+ The optional constructorOpt argument
+ accepts a function. If given, all frames above
+ constructorOpt, including
+ constructorOpt, will be omitted from the
+ generated stack trace.
+
+ The constructorOpt argument is useful for
+ hiding implementation details of error generation from
+ the user. For instance:
+
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
+OptionalconstructorOpt:
+ Function
+ StaticfromStaticprepare+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
++ Base class for MFA-related errors in auth0-spa-js. Extends + GenericError for unified error hierarchy across the SDK. +
+Optionalstack
+ Staticstack
+ The Error.stackTraceLimit property specifies the
+ number of stack frames collected by a stack trace (whether
+ generated by new Error().stack or
+ Error.captureStackTrace(obj)).
+
+ The default value is 10 but may be set to any
+ valid JavaScript number. Changes will affect any stack trace
+ captured after the value has been changed.
+
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+Staticcapture
+ Creates a .stack property on
+ targetObject, which when accessed returns a
+ string representing the location in the code at which
+ Error.captureStackTrace() was called.
+
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
+
+ The first line of the trace will be prefixed with
+ ${myObject.name}: ${myObject.message}.
+
+ The optional constructorOpt argument
+ accepts a function. If given, all frames above
+ constructorOpt, including
+ constructorOpt, will be omitted from the
+ generated stack trace.
+
+ The constructorOpt argument is useful for
+ hiding implementation details of error generation from
+ the user. For instance:
+
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
+OptionalconstructorOpt:
+ Function
+ StaticfromStaticprepare+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
+Error thrown when listing MFA authenticators fails.
+Optionalstack
+ Staticstack
+ The Error.stackTraceLimit property specifies the
+ number of stack frames collected by a stack trace (whether
+ generated by new Error().stack or
+ Error.captureStackTrace(obj)).
+
+ The default value is 10 but may be set to any
+ valid JavaScript number. Changes will affect any stack trace
+ captured after the value has been changed.
+
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+Staticcapture
+ Creates a .stack property on
+ targetObject, which when accessed returns a
+ string representing the location in the code at which
+ Error.captureStackTrace() was called.
+
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
+
+ The first line of the trace will be prefixed with
+ ${myObject.name}: ${myObject.message}.
+
+ The optional constructorOpt argument
+ accepts a function. If given, all frames above
+ constructorOpt, including
+ constructorOpt, will be omitted from the
+ generated stack trace.
+
+ The constructorOpt argument is useful for
+ hiding implementation details of error generation from
+ the user. For instance:
+
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
+OptionalconstructorOpt:
+ Function
+ StaticfromStaticprepare+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
+Error thrown when verifying an MFA challenge fails.
+try {
const tokens = await mfa.verify({
mfaToken: mfaToken,
grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
otp: '123456'
});
} catch (error) {
if (error instanceof MfaVerifyError) {
console.log(error.error); // 'invalid_otp' or 'context_not_found'
console.log(error.error_description); // Error details
}
}
+Optionalstack
+ Staticstack
+ The Error.stackTraceLimit property specifies the
+ number of stack frames collected by a stack trace (whether
+ generated by new Error().stack or
+ Error.captureStackTrace(obj)).
+
+ The default value is 10 but may be set to any
+ valid JavaScript number. Changes will affect any stack trace
+ captured after the value has been changed.
+
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+Staticcapture
+ Creates a .stack property on
+ targetObject, which when accessed returns a
+ string representing the location in the code at which
+ Error.captureStackTrace() was called.
+
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
+
+ The first line of the trace will be prefixed with
+ ${myObject.name}: ${myObject.message}.
+
+ The optional constructorOpt argument
+ accepts a function. If given, all frames above
+ constructorOpt, including
+ constructorOpt, will be omitted from the
+ generated stack trace.
+
+ The constructorOpt argument is useful for
+ hiding implementation details of error generation from
+ the user. For instance:
+
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
+OptionalconstructorOpt:
+ Function
+ StaticfromStaticprepare+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
+Error thrown when there is no refresh token to use
Thrown when network requests to the Auth server fail.
Thrown when network requests to the Auth server fail.
+Optionalstack
+ Staticstack
+ The Error.stackTraceLimit property specifies the
+ number of stack frames collected by a stack trace (whether
+ generated by new Error().stack or
+ Error.captureStackTrace(obj)).
+
+ The default value is 10 but may be set to any
+ valid JavaScript number. Changes will affect any stack trace
+ captured after the value has been changed.
+
+ If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +
+Staticcapture
+ Creates a .stack property on
+ targetObject, which when accessed returns a
+ string representing the location in the code at which
+ Error.captureStackTrace() was called.
+
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
+
+ The first line of the trace will be prefixed with
+ ${myObject.name}: ${myObject.message}.
+
+ The optional constructorOpt argument
+ accepts a function. If given, all frames above
+ constructorOpt, including
+ constructorOpt, will be omitted from the
+ generated stack trace.
+
+ The constructorOpt argument is useful for
+ hiding implementation details of error generation from
+ the user. For instance:
+
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
+OptionalconstructorOpt:
+ Function
+ StaticfromStaticprepare+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +
+Const
+ Observable-based MFA API client exposed by
+ AuthService.mfa.
+
+ This is the Angular counterpart of MfaApiClient from
+ @auth0/auth0-spa-js. All methods return
+ Observable instead of Promise.
+
+ Initiates an MFA challenge, sending an OOB code via SMS, + email, or push, or preparing for OTP entry. Required for + all factor types except OTP, where it is optional. +
++ Enrolls a new MFA authenticator (OTP, SMS, Voice, Email, + or Push). +
++ Returns the list of enrolled MFA authenticators for the + current user, filtered by the challenge types stored in + the MFA context. +
++ Returns the available enrollment factors from the stored + MFA context. A non-empty result means the user must + enroll before they can authenticate. +
+
+ Verifies an MFA challenge and returns raw tokens. The
+ grant type is inferred automatically from the provided
+ field: otp, oobCode, or
+ recoveryCode. Angular auth state
+ (isAuthenticated$, user$) is
+ not updated automatically — call
+ getAccessTokenSilently() afterwards to
+ reflect the new session.
+
Response when enrolling an OOB authenticator
+Authenticator type
+OptionalbarcodeURI for QR code (for Push/Guardian enrollment)
+OptionalbindingBinding method (e.g., 'prompt' for user code entry)
+Optionalid
+ Authenticator ID
+Delivery channel used
+OptionaloobOut-of-band code for verification
+Optionalrecovery+ Recovery codes (generated when enrolling first MFA factor) +
+Response when enrolling an OTP authenticator
+Authenticator type
+URI for generating QR code (otpauth://...)
+Optionalid
+ Authenticator ID
+OptionalrecoveryRecovery codes for account recovery
+Base32-encoded secret for TOTP generation
+Parameters for verifying an MFA challenge.
++ The grant_type is automatically inferred from which verification + field is provided: +
+otp field → MFA-OTP grant typeoobCode field → MFA-OOB grant typerecoveryCode field → MFA-RECOVERY-CODE grant type
+ OptionalbindingBinding code (for OOB challenges with binding)
+MFA token from challenge flow
+OptionaloobOut-of-band code (for OOB challenges)
+Optionalotp
+ One-time password (for OTP challenges)
+OptionalrecoveryRecovery code (for recovery code verification)
+
+ Provides MFA (Multi-Factor Authentication) operations as + Observables. +
++ These methods are available after +
+getAccessTokenSilentlythrows an +MfaRequiredError. Use the +mfa_tokenfrom the error to call these methods. +