Edit

Share via

ClientConfigurationError class

  • Reference
Package:
@azure/msal

Error thrown when there is an error in configuration of the .js library.

Extends
ClientAuthError

Constructors

ClientConfigurationError(string, string)

Inherited Properties

errorCode
errorMessage
message
name
stack

Methods

createClaimsRequestParsingError(string)
createEmptyRequestError()
createEmptyScopesArrayError(string)
createInvalidAuthorityMetadataError()
createInvalidAuthorityTypeError()
createInvalidCallbackObjectError(object)
createInvalidCorrelationIdError()
createInvalidPromptError(any)
createKnownAuthoritiesNotSetError()
createNoSetConfigurationError()
createRedirectCallbacksNotSetError()
createScopesNonArrayError(string)
createScopesRequiredError(any)
createSsoSilentError()
createStorageNotSupportedError(string)
createTelemetryConfigError(TelemetryOptions)
createUntrustedAuthorityError(string)

Inherited Methods

createAcquireTokenInProgressError()
createBlockTokenRequestsInHiddenIframeError()
createCacheParseError(string)
createClientInfoDecodingError(string)
createClientInfoNotPopulatedError(string)
createEndpointResolutionError(string)
createErrorInCallbackFunction(string)
createIdTokenNullOrEmptyError(string)
createIdTokenParsingError(string)
createInvalidIdTokenError(IdToken)
createInvalidInteractionTypeError()
createInvalidStateError(string, string)
createLoginInProgressError()
createMultipleAuthoritiesInCacheError(string)
createNonceMismatchError(string, string)
createNoWindowObjectError(string)
createPopupWindowError(string)
createTokenEncodingError(string)
createTokenRenewalTimeoutError()
createUnexpectedError(string)
createUserCancelledError()
createUserDoesNotExistError()
createUserLoginRequiredError()

Constructor Details

ClientConfigurationError(string, string) 

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

Parameters

errorCode

string

errorMessage

string

Inherited Property Details

errorCode 

errorCode: string

Property Value

string

Inherited From AuthError.errorCode

errorMessage 

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

Method Details

createClaimsRequestParsingError(string) 

static function createClaimsRequestParsingError(claimsRequestParseError: string): ClientConfigurationError

Parameters

claimsRequestParseError

string

Returns

ClientConfigurationError

createEmptyRequestError() 

static function createEmptyRequestError(): ClientConfigurationError

Returns

ClientConfigurationError

createEmptyScopesArrayError(string) 

static function createEmptyScopesArrayError(scopesValue: string): ClientConfigurationError

Parameters

scopesValue

string

Returns

ClientConfigurationError

createInvalidAuthorityMetadataError() 

static function createInvalidAuthorityMetadataError(): ClientConfigurationError

Returns

ClientConfigurationError

createInvalidAuthorityTypeError() 

static function createInvalidAuthorityTypeError(): ClientConfigurationError

Returns

ClientConfigurationError

createInvalidCallbackObjectError(object) 

static function createInvalidCallbackObjectError(callbackObject: object): ClientConfigurationError

Parameters

callbackObject

object

Returns

ClientConfigurationError

createInvalidCorrelationIdError() 

static function createInvalidCorrelationIdError(): ClientConfigurationError

Returns

ClientConfigurationError

createInvalidPromptError(any) 

static function createInvalidPromptError(promptValue: any): ClientConfigurationError

Parameters

promptValue

any

Returns

ClientConfigurationError

createKnownAuthoritiesNotSetError() 

static function createKnownAuthoritiesNotSetError(): ClientConfigurationError

Returns

ClientConfigurationError

createNoSetConfigurationError() 

static function createNoSetConfigurationError(): ClientConfigurationError

Returns

ClientConfigurationError

createRedirectCallbacksNotSetError() 

static function createRedirectCallbacksNotSetError(): ClientConfigurationError

Returns

ClientConfigurationError

createScopesNonArrayError(string) 

static function createScopesNonArrayError(scopesValue: string): ClientConfigurationError

Parameters

scopesValue

string

Returns

ClientConfigurationError

createScopesRequiredError(any) 

static function createScopesRequiredError(scopesValue: any): ClientConfigurationError

Parameters

scopesValue

any

Returns

ClientConfigurationError

createSsoSilentError() 

static function createSsoSilentError(): ClientConfigurationError

Returns

ClientConfigurationError

createStorageNotSupportedError(string) 

static function createStorageNotSupportedError(givenCacheLocation: string): ClientConfigurationError

Parameters

givenCacheLocation

string

Returns

ClientConfigurationError

createTelemetryConfigError(TelemetryOptions) 

static function createTelemetryConfigError(config: TelemetryOptions): ClientConfigurationError

Parameters

config
TelemetryOptions

Returns

ClientConfigurationError

createUntrustedAuthorityError(string) 

static function createUntrustedAuthorityError(host: string): ClientConfigurationError

Parameters

host

string

Returns

ClientConfigurationError

Inherited Method Details

createAcquireTokenInProgressError() 

static function createAcquireTokenInProgressError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createAcquireTokenInProgressError

createBlockTokenRequestsInHiddenIframeError() 

static function createBlockTokenRequestsInHiddenIframeError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createBlockTokenRequestsInHiddenIframeError

createCacheParseError(string) 

static function createCacheParseError(key: string): ClientAuthError

Parameters

key

string

Returns

ClientAuthError

Inherited From ClientAuthError.createCacheParseError

createClientInfoDecodingError(string) 

static function createClientInfoDecodingError(caughtError: string): ClientAuthError

Parameters

caughtError

string

Returns

ClientAuthError

Inherited From ClientAuthError.createClientInfoDecodingError

createClientInfoNotPopulatedError(string) 

static function createClientInfoNotPopulatedError(caughtError: string): ClientAuthError

Parameters

caughtError

string

Returns

ClientAuthError

Inherited From ClientAuthError.createClientInfoNotPopulatedError

createEndpointResolutionError(string) 

static function createEndpointResolutionError(errDetail?: string): ClientAuthError

Parameters

errDetail

string

Returns

ClientAuthError

Inherited From ClientAuthError.createEndpointResolutionError

createErrorInCallbackFunction(string) 

static function createErrorInCallbackFunction(errorDesc: string): ClientAuthError

Parameters

errorDesc

string

Returns

ClientAuthError

Inherited From ClientAuthError.createErrorInCallbackFunction

createIdTokenNullOrEmptyError(string) 

static function createIdTokenNullOrEmptyError(invalidRawTokenString: string): ClientAuthError

Parameters

invalidRawTokenString

string

Returns

ClientAuthError

Inherited From ClientAuthError.createIdTokenNullOrEmptyError

createIdTokenParsingError(string) 

static function createIdTokenParsingError(caughtParsingError: string): ClientAuthError

Parameters

caughtParsingError

string

Returns

ClientAuthError

Inherited From ClientAuthError.createIdTokenParsingError

createInvalidIdTokenError(IdToken) 

static function createInvalidIdTokenError(idToken: IdToken): ClientAuthError

Parameters

idToken

IdToken

Returns

ClientAuthError

Inherited From ClientAuthError.createInvalidIdTokenError

createInvalidInteractionTypeError() 

static function createInvalidInteractionTypeError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createInvalidInteractionTypeError

createInvalidStateError(string, string) 

static function createInvalidStateError(invalidState: string, actualState: string): ClientAuthError

Parameters

invalidState

string

actualState

string

Returns

ClientAuthError

Inherited From ClientAuthError.createInvalidStateError

createLoginInProgressError() 

static function createLoginInProgressError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createLoginInProgressError

createMultipleAuthoritiesInCacheError(string) 

static function createMultipleAuthoritiesInCacheError(scope: string): ClientAuthError

Parameters

scope

string

Returns

ClientAuthError

Inherited From ClientAuthError.createMultipleAuthoritiesInCacheError

createNonceMismatchError(string, string) 

static function createNonceMismatchError(invalidNonce: string, actualNonce: string): ClientAuthError

Parameters

invalidNonce

string

actualNonce

string

Returns

ClientAuthError

Inherited From ClientAuthError.createNonceMismatchError

createNoWindowObjectError(string) 

static function createNoWindowObjectError(errDesc: string): AuthError

Parameters

errDesc

string

Returns

AuthError

Inherited From AuthError.createNoWindowObjectError

createPopupWindowError(string) 

static function createPopupWindowError(errDetail?: string): ClientAuthError

Parameters

errDetail

string

Returns

ClientAuthError

Inherited From ClientAuthError.createPopupWindowError

createTokenEncodingError(string) 

static function createTokenEncodingError(incorrectlyEncodedToken: string): ClientAuthError

Parameters

incorrectlyEncodedToken

string

Returns

ClientAuthError

Inherited From ClientAuthError.createTokenEncodingError

createTokenRenewalTimeoutError() 

static function createTokenRenewalTimeoutError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createTokenRenewalTimeoutError

createUnexpectedError(string) 

static function createUnexpectedError(errDesc: string): AuthError

Parameters

errDesc

string

Returns

AuthError

Inherited From AuthError.createUnexpectedError

createUserCancelledError() 

static function createUserCancelledError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createUserCancelledError

createUserDoesNotExistError() 

static function createUserDoesNotExistError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createUserDoesNotExistError

createUserLoginRequiredError() 

static function createUserLoginRequiredError(): ClientAuthError

Returns

ClientAuthError

Inherited From ClientAuthError.createUserLoginRequiredError