Class ForbiddenError

The authenticated user does not have permission to perform this request.

Hierarchy (View Summary)

BaseError
- ForbiddenError

Index

Constructors

Properties

cause? code error error_description? error_uri? message name stack? state? statusCode prepareStackTrace? stackTraceLimit

Methods

payload captureStackTrace

Constructors

constructor

new ForbiddenError(data: ErrorData): ForbiddenError
Parameters
- data: ErrorData
Returns ForbiddenError
Overrides BaseError.constructor
- Defined in packages/oauth2-error-responses/src/client-errors.ts:136

Properties

`Optional`cause

cause?: unknown

`Readonly`code

code: string

`Readonly`error

error: string

`Optional` `Readonly`error_description

error_description?: string

`Optional` `Readonly`error_uri

error_uri?: string

message

message: string

name

name: string

`Optional`stack

stack?: string

`Optional` `Readonly`state

state?: string

`Readonly`statusCode

statusCode: number

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

payload

payload(
    options?: PayloadOptions,
):
    | {
        error: string;
        error_description: undefined
        | string;
        error_uri: undefined | string;
        state: undefined | string;
    }
    | {
        error: string;
        error_description?: undefined;
        error_uri?: undefined;
        state?: undefined;
    }
Parameters
- Optionaloptions: PayloadOptions
Returns
    | {
        error: string;
        error_description: undefined
        | string;
        error_uri: undefined | string;
        state: undefined | string;
    }
    | {
        error: string;
        error_description?: undefined;
        error_uri?: undefined;
        state?: undefined;
    }
Inherited from BaseError.payload
- Defined in packages/oauth2-error-responses/src/base.ts:61

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from BaseError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136