MsalServiceException Class

Definition

Namespace:

Microsoft.Identity.Client

Assembly:

Microsoft.Identity.Client.dll

Package:

Microsoft.Identity.Client v4.66.1

Exception type thrown when service returns an error response or other networking errors occur. For more details, see https://aka.ms/msal-net-exceptions

public class MsalServiceException : Microsoft.Identity.Client.MsalException

type MsalServiceException = class
    inherit MsalException

Public Class MsalServiceException
Inherits MsalException

Inheritance

Exception

MsalException

MsalServiceException

Derived

Microsoft.Identity.Client.IntuneAppProtectionPolicyRequiredException

Microsoft.Identity.Client.MsalManagedIdentityException

Microsoft.Identity.Client.MsalThrottledServiceException

Microsoft.Identity.Client.MsalUiRequiredException

Constructors

MsalServiceException(String, String, Exception)	Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception.
MsalServiceException(String, String, Int32, Exception)	Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception.
MsalServiceException(String, String, Int32, String, Exception)	Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception.
MsalServiceException(String, String, Int32)	Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception.
MsalServiceException(String, String)	Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this 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)
Claims	Additional claims requested by the service. When this property is not null or empty, this means that the service requires the user to provide additional claims, such as doing two factor authentication. The are two cases: If your application is a IPublicClientApplication, you should just call AcquireTokenInteractive(IEnumerable<String>) and add the WithClaims(String) modifier. If your application is a IConfidentialClientApplication, (therefore doing the On-Behalf-Of flow), you should throw an HTTP unauthorize exception with a message containing the claims For more details see https://aka.ms/msal-net-claim-challenge
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)
Headers	Contains the HTTP headers from the server response that indicated an error.
IsRetryable	Indicates if the previous operation that resulted in this exception should be retried. (Inherited from MsalException)
ResponseBody	Raw response body received from the server.
StatusCode	Gets the status code returned from HTTP layer. This status code is either the HttpStatusCode in the inner HttpRequestException response or the NavigateError Event Status Code in a browser based flow (see NavigateError Event Status Codes). You can use this code for purposes such as implementing retry logic or error investigation.

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.
UpdateIsRetryable()	As per discussion with Evo, AAD