InteractionRequiredAuthError class

new InteractionRequiredAuthError(errorCode?: string, errorMessage?: string, subError?: string, timestamp?: string, traceId?: string, correlationId?: string, claims?: string, errorNo?: string)

Parameters

https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/claims-challenge.md

A string with extra claims needed for the token request to succeed web site: redirect the user to the authorization page and set the extra claims web api: include the claims in the WWW-Authenticate header that are sent back to the client so that it knows to request a token with the extra claims desktop application or browser context: include the claims when acquiring the token interactively app to app context (client_credentials): include the claims in the AcquireTokenByClientCredential request

claims: string

Property Value

Server error number;

errorNo?: string

Property Value

The time the error occured at

timestamp: string

Property Value

TraceId associated with the error

traceId: string

Property Value

CorrelationId associated with the error

correlationId: string

Property Value

Inherited From AuthError.correlationId

Short string denoting error

errorCode: string

Property Value

Inherited From AuthError.errorCode

Detailed description of error

errorMessage: string

Property Value

Inherited From AuthError.errorMessage

message: string

Property Value

Inherited From AuthError.message

name: string

Property Value

Inherited From AuthError.name

stack?: string

Property Value

Inherited From AuthError.stack

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.

static stackTraceLimit: number

Property Value

Inherited From AuthError.stackTraceLimit

Describes the subclass of an error

subError: string

Property Value

Inherited From AuthError.subError

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

static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Parameters

Inherited From AuthError.captureStackTrace

See https://v8.dev/docs/stack-trace-api#customizing-stack-traces

static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Parameters

Returns

Inherited From AuthError.prepareStackTrace

function setCorrelationId(correlationId: string)

Parameters

Inherited From AuthError.setCorrelationId