@faable/auth-js - v2.8.1
    Preparing search index...

    Class AuthMfaRequiredError

    The tenant requires a second factor and this grant has no browser to send the user to a challenge screen, so the server handed back a token to come back with.

    Finish the sign-in with FaableAuthClient.signInWithMfa, passing the mfa_token from this error and the code the user typed. The token is single-use and short-lived, but a WRONG code does not consume it — prompt again with the same token rather than restarting the whole flow.

    Hierarchy

    • CustomAuthError
      • AuthMfaRequiredError
    Index

    Constructors

    Properties

    cause?: unknown
    code: string | undefined

    Error code associated with the error. Most errors coming from HTTP responses will have a code, though some errors that occur before a response is received will not have one present. In that case AuthError.status will also be undefined.

    factors: string[]

    Which kinds of factor would satisfy the policy (totp, webauthn). EMPTY means the user has none enrolled and must enrol one first — on the hosted security page, since enrolment is not something an application can do on the user's behalf.

    message: string
    mfa_token: string

    Opaque token identifying the interrupted grant.

    name: string
    stack?: string
    status: number

    HTTP status code that caused the error.

    stackTraceLimit: number

    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.

    Methods

    • 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();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error