BrowserAuthError class

Package:

@azure/msal-browser

Browser library error class thrown by the MSAL.js library for SPAs

Extends

AuthError

Constructors

BrowserAuthError(string, string)

Inherited Properties

correlationId	CorrelationId associated with the error
errorCode	Short string denoting error
errorMessage	Detailed description of error
message
name
stack
subError	Describes the subclass of an error

Methods

createAuthCodeOrNativeAccountIdRequiredError()	Create an error when an authorization code or native account ID is required but not provided
createAuthCodeRequiredError()	Create an error when an authorization code is required but not provided
createAuthRequestNotSetError()	Creates an error thrown when handleCodeResponse is called before initiateAuthRequest (InteractionHandler)
createBlockAcquireTokenInPopupsError()	Creates an error thrown when a popup attempts to call an acquireToken API
createBlockReloadInHiddenIframeError()	Creates an error thrown when an auth reload is done inside an iframe.
createCryptoNotAvailableError(string)	Creates an error thrown when the crypto object is unavailable.
createDatabaseNotOpenError()	Create an error thrown when indexDB database is not open
createDatabaseUnavailableError()	Create an error when IndexedDB is unavailable
createEmptyHashError(string)	Creates an error thrown when the hash string value is unexpectedly empty.
createEmptyNavigationUriError()	Creates an error thrown when the navigation URI is empty.
createEmptyWindowCreatedError()	Creates an error thrown when window.open returns an empty window object.
createFailedToParseNetworkResponseError(string)	Create an error thrown when network client fails to parse network response
createGetRequestFailedError(string, string)	Create an error thrown when get request fails due to reasons other than internet connectivity
createHashDoesNotContainKnownPropertiesError()	Creates an error thrown when the hash string value does not contain known properties
createHashDoesNotContainStateError()	Creates an error thrown when the hash string value is unexpectedly empty.
createHttpMethodNotImplementedError(string)	Creates an error thrown when an HTTP method hasn't been implemented by the browser class.
createIframeClosedPrematurelyError()	Creates an error thrown when an iframe is found to be closed before the timeout is reached.
createInteractionInProgressError()	Creates an error thrown when a browser interaction (redirect or popup) is in progress.
createInvalidCacheTypeError()	Creates an error thrown if cache type is invalid.
createMonitorIframeTimeoutError()	Creates an error thrown when monitorIframeFromHash times out for a given iframe.
createMonitorPopupTimeoutError()	Creates an error thrown when monitorPopupFromHash times out for a given popup.
createNativeBrokerCalledBeforeInitialize()	Create an error thrown when the initialize function hasn't been called
createNativeConnectionNotEstablishedError()	Create an error when native connection has not been established
createNativeExtensionNotInstalledError()	Create an error thrown when browser extension is not installed
createNativeHandshakeTimeoutError()	Create an error thrown when Handshake with browser extension times out
createNativePromptParameterNotSupportedError()	Create an error thrown when requesting a token directly from the native platform with an unsupported prompt parameter e.g. select_account, login or create These requests must go through eSTS to ensure eSTS is aware of the new account
createNoAccountError()	Creates an error thrown when the account object is not provided in the acquireTokenSilent API.
createNoCachedAuthorityError()	Creates an error thrown when the authority could not be retrieved from the cache
createNonBrowserEnvironmentError()	Create an error thrown when login and token requests are made from a non-browser environment
createNoNetworkConnectivityError()	Create an error thrown when token fetch fails due to no internet
createNoTokenRequestCacheError()	Creates an error thrown when the token request could not be retrieved from the cache
createPkceNotGeneratedError(string)	Creates an error thrown when PKCE is not implemented.
createPopupWindowError(string)	Creates an error thrown when the popup window could not be opened.
createPostRequestFailedError(string, string)	Create an error thrown when token fetch fails due to reasons other than internet connectivity
createRedirectInIframeError(boolean)	Creates an error thrown when navigateWindow is called inside an iframe or brokered applications.
createSigningKeyNotFoundInStorageError(string)	Create an error thrown when the queried cryptographic key is not found in IndexedDB
createSilentLogoutUnsupportedError()	Creates an error thrown when the logout API is called on any of the silent interaction clients
createSilentPromptValueError(string)	Creates an error thrown when a given prompt value is invalid for silent requests.
createStateInteractionTypeMismatchError()	Creates an error thrown when the state value in the hash does not match the interaction type of the API attempting to consume it.
createUnableToAcquireTokenFromNativePlatformError()	Create an error when native token acquisition is not possible
createUnableToLoadTokenError(string)	Create an error thrown when the necessary information is not available to sideload tokens
createUnableToParseStateError()	Creates an error thrown when the hash string value is unexpectedly empty.
createUnableToParseTokenRequestCacheError()	Creates an error thrown when the cached token request could not be retrieved from the cache
createUserCancelledError()	Creates an error thrown when the user closes a popup.

Inherited Methods

createPostRequestFailed(string)	Creates an error for post request failures.
createUnexpectedError(string)	Creates an error that is thrown when something unexpected happens in the library.
setCorrelationId(string)

Constructor Details

BrowserAuthError(string, string)

new BrowserAuthError(errorCode: string, errorMessage?: string)

Parameters

errorCode

string

errorMessage

string

Inherited Property Details

correlationId

CorrelationId associated with the error

correlationId: string

Property Value

string

Inherited From AuthError.correlationId

errorCode

Short string denoting error

errorCode: string

Property Value

string

Inherited From AuthError.errorCode

errorMessage

Detailed description of error

errorMessage: string

Property Value

string

Inherited From AuthError.errorMessage

message

message: string

Property Value

string

Inherited From Error.message

name

name: string

Property Value

string

Inherited From Error.name

stack

stack?: string

Property Value

string

Inherited From Error.stack

subError

Describes the subclass of an error

subError: string

Property Value

string

Inherited From AuthError.subError

Method Details

createAuthCodeOrNativeAccountIdRequiredError()

Create an error when an authorization code or native account ID is required but not provided

static function createAuthCodeOrNativeAccountIdRequiredError(): BrowserAuthError

Returns

BrowserAuthError

createAuthCodeRequiredError()

Create an error when an authorization code is required but not provided

static function createAuthCodeRequiredError(): BrowserAuthError

Returns

BrowserAuthError

createAuthRequestNotSetError()

Creates an error thrown when handleCodeResponse is called before initiateAuthRequest (InteractionHandler)

static function createAuthRequestNotSetError(): BrowserAuthError

Returns

BrowserAuthError

createBlockAcquireTokenInPopupsError()

Creates an error thrown when a popup attempts to call an acquireToken API

static function createBlockAcquireTokenInPopupsError(): BrowserAuthError

Returns

BrowserAuthError

createBlockReloadInHiddenIframeError()

Creates an error thrown when an auth reload is done inside an iframe.

static function createBlockReloadInHiddenIframeError(): BrowserAuthError

Returns

BrowserAuthError

createCryptoNotAvailableError(string)

Creates an error thrown when the crypto object is unavailable.

static function createCryptoNotAvailableError(errDetail: string): BrowserAuthError

Parameters

errDetail

string

Returns

BrowserAuthError

createDatabaseNotOpenError()

Create an error thrown when indexDB database is not open

static function createDatabaseNotOpenError(): BrowserAuthError

Returns

BrowserAuthError

createDatabaseUnavailableError()

Create an error when IndexedDB is unavailable

static function createDatabaseUnavailableError(): BrowserAuthError

Returns

BrowserAuthError

createEmptyHashError(string)

Creates an error thrown when the hash string value is unexpectedly empty.

static function createEmptyHashError(hashValue: string): BrowserAuthError

Parameters

hashValue

string

Returns

BrowserAuthError

createEmptyNavigationUriError()

Creates an error thrown when the navigation URI is empty.

static function createEmptyNavigationUriError(): BrowserAuthError

Returns

BrowserAuthError

createEmptyWindowCreatedError()

Creates an error thrown when window.open returns an empty window object.

static function createEmptyWindowCreatedError(): BrowserAuthError

Returns

BrowserAuthError

createFailedToParseNetworkResponseError(string)

Create an error thrown when network client fails to parse network response

static function createFailedToParseNetworkResponseError(endpoint: string): BrowserAuthError

Parameters

endpoint

string

Returns

BrowserAuthError

createGetRequestFailedError(string, string)

Create an error thrown when get request fails due to reasons other than internet connectivity

static function createGetRequestFailedError(errorDesc: string, endpoint: string): BrowserAuthError

Parameters

errorDesc

string

endpoint

string

Returns

BrowserAuthError

createHashDoesNotContainKnownPropertiesError()

Creates an error thrown when the hash string value does not contain known properties

static function createHashDoesNotContainKnownPropertiesError(): BrowserAuthError

Returns

BrowserAuthError

createHashDoesNotContainStateError()

Creates an error thrown when the hash string value is unexpectedly empty.

static function createHashDoesNotContainStateError(): BrowserAuthError

Returns

BrowserAuthError

createHttpMethodNotImplementedError(string)

Creates an error thrown when an HTTP method hasn't been implemented by the browser class.

static function createHttpMethodNotImplementedError(method: string): BrowserAuthError

Parameters

method

string

Returns

BrowserAuthError

createIframeClosedPrematurelyError()

Creates an error thrown when an iframe is found to be closed before the timeout is reached.

static function createIframeClosedPrematurelyError(): BrowserAuthError

Returns

BrowserAuthError

createInteractionInProgressError()

Creates an error thrown when a browser interaction (redirect or popup) is in progress.

static function createInteractionInProgressError(): BrowserAuthError

Returns

BrowserAuthError

createInvalidCacheTypeError()

Creates an error thrown if cache type is invalid.

static function createInvalidCacheTypeError(): BrowserAuthError

Returns

BrowserAuthError

createMonitorIframeTimeoutError()

Creates an error thrown when monitorIframeFromHash times out for a given iframe.

static function createMonitorIframeTimeoutError(): BrowserAuthError

Returns

BrowserAuthError

createMonitorPopupTimeoutError()

Creates an error thrown when monitorPopupFromHash times out for a given popup.

static function createMonitorPopupTimeoutError(): BrowserAuthError

Returns

BrowserAuthError

createNativeBrokerCalledBeforeInitialize()

Create an error thrown when the initialize function hasn't been called

static function createNativeBrokerCalledBeforeInitialize(): BrowserAuthError

Returns

BrowserAuthError

createNativeConnectionNotEstablishedError()

Create an error when native connection has not been established

static function createNativeConnectionNotEstablishedError(): BrowserAuthError

Returns

BrowserAuthError

createNativeExtensionNotInstalledError()

Create an error thrown when browser extension is not installed

static function createNativeExtensionNotInstalledError(): BrowserAuthError

Returns

BrowserAuthError

createNativeHandshakeTimeoutError()

Create an error thrown when Handshake with browser extension times out

static function createNativeHandshakeTimeoutError(): BrowserAuthError

Returns

BrowserAuthError

createNativePromptParameterNotSupportedError()

Create an error thrown when requesting a token directly from the native platform with an unsupported prompt parameter e.g. select_account, login or create These requests must go through eSTS to ensure eSTS is aware of the new account

static function createNativePromptParameterNotSupportedError(): BrowserAuthError

Returns

BrowserAuthError

createNoAccountError()

Creates an error thrown when the account object is not provided in the acquireTokenSilent API.

static function createNoAccountError(): BrowserAuthError

Returns

BrowserAuthError

createNoCachedAuthorityError()

Creates an error thrown when the authority could not be retrieved from the cache

static function createNoCachedAuthorityError(): BrowserAuthError

Returns

BrowserAuthError

createNonBrowserEnvironmentError()

Create an error thrown when login and token requests are made from a non-browser environment

static function createNonBrowserEnvironmentError(): BrowserAuthError

Returns

BrowserAuthError

createNoNetworkConnectivityError()

Create an error thrown when token fetch fails due to no internet

static function createNoNetworkConnectivityError(): BrowserAuthError

Returns

BrowserAuthError

createNoTokenRequestCacheError()

Creates an error thrown when the token request could not be retrieved from the cache

static function createNoTokenRequestCacheError(): BrowserAuthError

Returns

BrowserAuthError

createPkceNotGeneratedError(string)

Creates an error thrown when PKCE is not implemented.

static function createPkceNotGeneratedError(errDetail: string): BrowserAuthError

Parameters

errDetail

string

Returns

BrowserAuthError

createPopupWindowError(string)

Creates an error thrown when the popup window could not be opened.

static function createPopupWindowError(errDetail?: string): BrowserAuthError

Parameters

errDetail

string

Returns

BrowserAuthError

createPostRequestFailedError(string, string)

Create an error thrown when token fetch fails due to reasons other than internet connectivity

static function createPostRequestFailedError(errorDesc: string, endpoint: string): BrowserAuthError

Parameters

errorDesc

string

endpoint

string

Returns

BrowserAuthError

createRedirectInIframeError(boolean)

Creates an error thrown when navigateWindow is called inside an iframe or brokered applications.

static function createRedirectInIframeError(windowParentCheck: boolean): BrowserAuthError

Parameters

windowParentCheck

boolean

Returns

BrowserAuthError

createSigningKeyNotFoundInStorageError(string)

Create an error thrown when the queried cryptographic key is not found in IndexedDB

static function createSigningKeyNotFoundInStorageError(keyId: string): BrowserAuthError

Parameters

keyId

string

Returns

BrowserAuthError

createSilentLogoutUnsupportedError()

Creates an error thrown when the logout API is called on any of the silent interaction clients

static function createSilentLogoutUnsupportedError(): BrowserAuthError

Returns

BrowserAuthError

createSilentPromptValueError(string)

Creates an error thrown when a given prompt value is invalid for silent requests.

static function createSilentPromptValueError(givenPrompt: string): BrowserAuthError

Parameters

givenPrompt

string

Returns

BrowserAuthError

createStateInteractionTypeMismatchError()

Creates an error thrown when the state value in the hash does not match the interaction type of the API attempting to consume it.

static function createStateInteractionTypeMismatchError(): BrowserAuthError

Returns

BrowserAuthError

createUnableToAcquireTokenFromNativePlatformError()

Create an error when native token acquisition is not possible

static function createUnableToAcquireTokenFromNativePlatformError(): BrowserAuthError

Returns

BrowserAuthError

createUnableToLoadTokenError(string)

Create an error thrown when the necessary information is not available to sideload tokens

static function createUnableToLoadTokenError(errorDetail: string): BrowserAuthError

Parameters

errorDetail

string

Returns

BrowserAuthError

createUnableToParseStateError()

Creates an error thrown when the hash string value is unexpectedly empty.

static function createUnableToParseStateError(): BrowserAuthError

Returns

BrowserAuthError

createUnableToParseTokenRequestCacheError()

Creates an error thrown when the cached token request could not be retrieved from the cache

static function createUnableToParseTokenRequestCacheError(): BrowserAuthError

Returns

BrowserAuthError

createUserCancelledError()

Creates an error thrown when the user closes a popup.

static function createUserCancelledError(): BrowserAuthError

Returns

BrowserAuthError

Inherited Method Details

createPostRequestFailed(string)

Creates an error for post request failures.

static function createPostRequestFailed(errDesc: string): AuthError

Parameters

errDesc

string

Returns

AuthError

Inherited From AuthError.createPostRequestFailed

createUnexpectedError(string)

Creates an error that is thrown when something unexpected happens in the library.

static function createUnexpectedError(errDesc: string): AuthError

Parameters

errDesc

string

Returns

AuthError

Inherited From AuthError.createUnexpectedError

setCorrelationId(string)

function setCorrelationId(correlationId: string)

Parameters

correlationId

string

Inherited From AuthError.setCorrelationId