Class: ForbiddenError

ForbiddenError

"403 Forbidden" response error class.

Indicates that the server understands the request but refuses to authorize it.

This status is similar to 401, but for the 403 Forbidden status code, re-authenticating makes no difference. The access is tied to the application logic, such as insufficient rights to a resource.

Constructor

new ForbiddenError(dataopt)

ForbiddenError constructor

Parameters:

Name	Type	Attributes	Description
`data`	Object \| String \| ResponseErrorOptions \| Options \| undefined	<optional>	Error message or options

Source: forbidden-error.js, line 18

Extends

ResponseError

Members

status

Error status

Overrides: ResponseError#status
Source: response-error.js, line 58

Examples

404 Not Found

451 Unavailable For Legal Reasons

500 Internal Server Error

Methods

toJSON() → {Object}

Plain object representation of the error

Overrides: ResponseError#toJSON
Source: response-error.js, line 105

Returns:

Type:: Object

Example

// returned JSON
{
  error: {
    code: 400,
    requestId: '123456-test-request-id',
    message: 'Baaaaaad Request :-(',
    details: 'Check your request body'
  }
}

toPojo() → {Object}

Plain object representation of the error

Overrides: ResponseError#toPojo
Source: response-error.js, line 78

Returns:

Type:: Object

Example

// returned object
{
  error: {
    code: 400,
    requestId: '123456-test-request-id',
    message: 'Baaaaaad Request :-(',
    details: 'Check your request body'
  }
}

toString() → {string}

String representation of the error

Overrides: ResponseError#toString
Source: response-error.js, line 118

Returns:

Type:: string

Example

// returned string
{"error":{"code":400,"requestId":"123456-test-request-id","message":"Baaaaaad Request :-(","details":"Check your request body"}}