MsalUiRequiredException Class

Definition

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
MsalUiRequiredException

Constructors

MsalUiRequiredException(String, String)

Initializes a new instance of the exception class with a specified error code and error message.

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, Exception, UiRequiredExceptionClassification)

Initializes a new instance of the exception class with a specified error code, error message and inner exception indicating the root cause.

Properties

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:

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 MsalServiceException)
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)
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 the NavigateError Event Status Code in a browser based flow (See http://msdn.microsoft.com/en-us/library/bb268233(v=vs.85).aspx). 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)

Applies to