Share via

AuthenticationError class

  • Reference
Package:
@azure/identity

Provides details about a failure to authenticate with Azure Active Directory. The errorResponse field contains more details about the specific failure.

Extends

Error

Constructors

AuthenticationError(number, undefined | null | string | object, { cause?: unknown })

Properties

errorResponse

The error response details.
statusCode

The HTTP status code returned from the authentication request.

Inherited Properties

message
name
prepareStackTrace

Optional override for formatting stack traces

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

Inherited Methods

captureStackTrace(object, Function)

Create .stack property on a target object

Constructor Details

AuthenticationError(number, undefined | null | string | object, { cause?: unknown }) 

new AuthenticationError(statusCode: number, errorBody: undefined | null | string | object, options?: { cause?: unknown })

Parameters

statusCode

number

errorBody

undefined | null | string | object

options

{ cause?: unknown }

Property Details

errorResponse

The error response details.

errorResponse: ErrorResponse

Property Value

ErrorResponse

statusCode

The HTTP status code returned from the authentication request.

statusCode: number

Property Value

number

Inherited Property Details

message 

message: string

Property Value

string

Inherited From Error.message

name 

name: string

Property Value

string

Inherited From Error.name

prepareStackTrace

Optional override for formatting stack traces

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

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

Property Value

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

Inherited From Error.prepareStackTrace

stack 

stack?: string

Property Value

string

Inherited From Error.stack

stackTraceLimit 

static stackTraceLimit: number

Property Value

number

Inherited From Error.stackTraceLimit

Inherited Method Details

captureStackTrace(object, Function)

Create .stack property on a target object

static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Parameters

targetObject

object

constructorOpt

Function

Inherited From Error.captureStackTrace