MsalClientException Class

Reference

Definition

Namespace:: Microsoft.Identity.Client

Assembly:: Microsoft.Identity.Client.dll

Package:: Microsoft.Identity.Client v4.60.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This exception class represents errors that are local to the library or the device. Contrary to MsalServiceException which represent errors happening from the Azure AD service or the network. For more details, see https://aka.ms/msal-net-exceptions

public class MsalClientException : Microsoft.Identity.Client.MsalException

type MsalClientException = class
    inherit MsalException

Public Class MsalClientException
Inherits MsalException

Inheritance: Exception

MsalException
MsalClientException

Constructors

MsalClientException(String)	Initializes a new instance of the exception class with a specified error code.
MsalClientException(String, String)	Initializes a new instance of the exception class with a specified error code and error message.
MsalClientException(String, String, Exception)	Initializes a new instance of the exception class with a specified error code, error message and inner exception.

Fields

BrokerErrorCode	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerErrorContext	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerErrorStatus	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerErrorTag	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerTelemetry	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
ManagedIdentitySource	An AdditionalExceptionData property key, available when using managed identity. (Inherited from MsalException)

Properties

AdditionalExceptionData	A property bag with extra details for this exception. (Inherited from MsalException)
CorrelationId	An ID that can used to piece up a single authentication flow. (Inherited from MsalException)
ErrorCode	Gets the protocol error code returned by the service or generated by the client. This is the code you can rely on for exception handling. Values for this code are typically provided in constant strings in the derived exceptions types with explanations of mitigation. (Inherited from MsalException)
IsRetryable	Indicates if the previous operation that resulted in this exception should be retried. (Inherited from MsalException)

Methods

ToJsonString()	Allows serialization of most values of the exception into JSON. (Inherited from MsalException)
ToString()	Creates and returns a string representation of the current exception. (Inherited from MsalException)

Applies to