Skip to main content
Version: 57.2.0

ForbiddenError

403 Forbidden.

Extends​

Constructors​

Constructor​

new ForbiddenError(options): ForbiddenError

Parameters​

options​

APIErrorSubclassOptions

Returns​

ForbiddenError

Overrides​

APIError.constructor

Properties​

code​

code: string | undefined

Inherited from​

APIError.code

detail​

detail: string | undefined

Inherited from​

APIError.detail

disableExternalErrorTracking?​

optional disableExternalErrorTracking?: boolean

Inherited from​

APIError.disableExternalErrorTracking

id​

id: string | undefined

Inherited from​

APIError.id

isTerrenoAPIError​

readonly isTerrenoAPIError: true = true

Inherited from​

APIError.isTerrenoAPIError

links: { about?: string; type?: string; } | undefined

Inherited from​

APIError.links

meta​

meta: {[id: string]: unknown; } | undefined

Inherited from​

APIError.meta

source​

source: { header?: string; parameter?: string; pointer?: string; } | undefined

Inherited from​

APIError.source

status​

status: number

Inherited from​

APIError.status

Accessors​

error​

Get Signature​

get error(): unknown

Deprecated​

Use the standard cause field instead.

Returns​

unknown

Inherited from​

APIError.error

title​

Get Signature​

get title(): string

Returns​

string

Inherited from​

APIError.title

Methods​

toJSON()​

toJSON(): APIErrorBody

Returns​

APIErrorBody

Inherited from​

APIError.toJSON