MsalUiRequiredException Class

Definition

Namespace:

Microsoft.Identity.Client

Assembly:

Microsoft.Identity.Client.dll

Package:

Microsoft.Identity.Client v4.66.2

This exception class is to inform developers that UI interaction is required for authentication to succeed. It's thrown when calling AcquireTokenSilent(IEnumerable<String>, IAccount) or one of its overrides, and when the token does not exists in the cache, or the user needs to provide more content, or perform multiple factor authentication based on Azure AD policies, etc.. For more details, see https://aka.ms/msal-net-exceptions

public class MsalUiRequiredException : Microsoft.Identity.Client.MsalServiceException

type MsalUiRequiredException = class
    inherit MsalServiceException

Public Class MsalUiRequiredException
Inherits MsalServiceException

Inheritance

Exception

MsalException

MsalServiceException

MsalUiRequiredException

Derived

Microsoft.Identity.Client.MsalClaimsChallengeException

Microsoft.Identity.Client.MsalThrottledUiRequiredException

Constructors

MsalUiRequiredException(String, String, Exception, UiRequiredExceptionClassification)	Initializes a new instance of the exception class with a specified error code, error message and inner exception indicating the root cause.
MsalUiRequiredException(String, String, Exception)	Initializes a new instance of the exception class with a specified error code, error message and inner exception indicating the root cause.
MsalUiRequiredException(String, String)	Initializes a new instance of the exception class with a specified error code and error message.

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 (Inherited from MsalServiceException)
Classification	Classification of the conditional access error, enabling you to do more actions or inform the user depending on your scenario. See https://aka.ms/msal-net-UiRequiredException for more details.
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. (Inherited from MsalServiceException)
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. (Inherited from MsalServiceException)
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. (Inherited from MsalServiceException)

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