Optionaloptions: ApiErrorOptionsReadonly[ReadonlybodyAtlassian's error payload, parsed when it was JSON and the raw text when it was not.
OptionalcauseOptionalstackReadonlystatusHTTP status.
ReadonlystatusStaticstackThe 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[hasStaticcaptureCreates 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: FunctionStaticprepare
401 with
Unauthorized; scope does not match— the token is valid, but the app never asked for a scope this endpoint needs.A subclass of AuthError because it is still a 401, but worth its own type: refreshing the token cannot fix it, so the client does not try. The app needs the scope added in the developer console and the user has to consent again.
Which scope is missing is the operation's own business, and its API documentation names it.
PRODUCT.scopeHintcarries whatever else is worth saying for this product, and the thrown message repeats it.