Class DocumentsAuthenticationError

OAuth2 token endpoint failure (RFC 6749 error responses).

Hierarchy (View Summary)

DocumentsApiError
- DocumentsAuthenticationError
  - BcfAuthenticationError

Index

Constructors

Properties

detail? errorCode? status url

Accessors

Constructors

constructor

new DocumentsAuthenticationError(
    message: string,
    options: {
        detail?: string;
        errorCode?: string;
        namespace?: string;
        status: number;
        url: string;
    },
): DocumentsAuthenticationError
Parameters
- message: string
- options: {
      detail?: string;
      errorCode?: string;
      namespace?: string;
      status: number;
      url: string;
  }
Returns DocumentsAuthenticationError

Overrides DocumentsApiError.constructor

Properties

`Optional` `Readonly`detail

detail?: string

Server-provided error detail, when the body carried one.

`Optional` `Readonly`errorCode

errorCode?: string

RFC 6749 error code, e.g. 'invalid_grant' or 'invalid_request'.

`Readonly`status

status: number

HTTP status code; 0 when the request never produced a response.

`Readonly`url

url: string

Request URL with any query string, for diagnostics.

Accessors

isAuthError

get isAuthError(): boolean

True when the server rejected the credentials (sign in again).

Returns boolean

Inherited from FoundationApiError.isAuthError