MsalUiRequiredException クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
この例外クラスは、認証を成功させるために UI 操作が必要であることを開発者に通知することです。 これは、AcquireTokenSilent(IEnumerable<String>, IAccount)またはそのオーバーライドの呼び出し時、トークンがキャッシュに存在しない場合、またはユーザーがより多くのコンテンツを提供する必要がある場合や、Azure AD ポリシーなどに基づいて多要素認証を実行する必要がある場合にスローされます。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください
public class MsalUiRequiredException : Microsoft.Identity.Client.MsalServiceExceptiontype MsalUiRequiredException = class
inherit MsalServiceExceptionPublic Class MsalUiRequiredException
Inherits MsalServiceException- 継承
- 派生
コンストラクター
| Name | 説明 |
|---|---|
| MsalUiRequiredException(String, String, Exception, UiRequiredExceptionClassification) |
指定したエラー コード、エラー メッセージ、および根本原因を示す内部例外を使用して、例外クラスの新しいインスタンスを初期化します。 |
| MsalUiRequiredException(String, String, Exception) |
指定したエラー コード、エラー メッセージ、および根本原因を示す内部例外を使用して、例外クラスの新しいインスタンスを初期化します。 |
| MsalUiRequiredException(String, String) |
指定したエラー コードとエラー メッセージを使用して、例外クラスの新しいインスタンスを初期化します。 |
フィールド
| Name | 説明 |
|---|---|
| AuthenticationResultMetadataKey |
MsalException以外でトークンの取得が失敗したときに MSAL がキャプチャしたAuthenticationResultMetadataを格納するDataのキー。 ダウンストリーム コンシューマーが、元の例外が変更されずに再スローされた場合でも、トークン取得診断を表示できるようにします。 (継承元 MsalException) |
| BrokerErrorCode |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 (継承元 MsalException) |
| BrokerErrorContext |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 (継承元 MsalException) |
| BrokerErrorStatus |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 (継承元 MsalException) |
| BrokerErrorTag |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 (継承元 MsalException) |
| BrokerTelemetry |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 (継承元 MsalException) |
| ManagedIdentitySource |
AdditionalExceptionData プロパティ キー。マネージド ID を使用する場合に使用できます。 (継承元 MsalException) |
プロパティ
| Name | 説明 |
|---|---|
| AdditionalExceptionData |
この例外の詳細が含まれたプロパティ バッグ。 (継承元 MsalException) |
| AuthenticationResultMetadata |
失敗したトークン取得試行の診断メタデータ - 合計期間と、関連するステージが実行されたとき、HTTP/キャッシュ期間、トークン エンドポイント、および使用されるリージョン。 これは、要求パイプラインがメタデータの収集を開始する前に例外がスローされたときに |
| Claims |
サービスによって要求された追加の要求。 このプロパティが null または空でない場合、これは、サービスがユーザーに 2 要素認証などの追加の要求を提供することを要求することを意味します。 次の 2 つのケースがあります。
|
| Classification |
条件付きアクセス エラーの分類。シナリオに応じて、より多くのアクションを実行したり、ユーザーに通知したりできます。 詳細については、 https://aka.ms/msal-net-UiRequiredException をご覧ください。 |
| CorrelationId |
1 つの認証フローを分割するために使用できる ID。 (継承元 MsalException) |
| ErrorCode |
サービスによって返されるか、クライアントによって生成されたプロトコル エラー コードを取得します。 これは、例外処理に依存できるコードです。 このコードの値は、通常、軽減策の説明を含む派生例外型の定数文字列で提供されます。 (継承元 MsalException) |
| ErrorCodesForLogging |
トークン サービスによって返される STS 固有のエラー コード ( |
| Headers |
エラーを示したサーバー応答からの HTTP ヘッダーが含まれています。 (継承元 MsalServiceException) |
| IsRetryable |
この例外が発生した前の操作を再試行する必要があるかどうかを示します。 (継承元 MsalException) |
| ResponseBody |
サーバーから受信した未加工の応答本文。 (継承元 MsalServiceException) |
| StatusCode |
HTTP レイヤーから返される状態コードを取得します。 この状態コードは、内部 |
| SubErrorForLogging |
トークン サービスによる ErrorCode の絞り込みによって返されるサブエラー ( |
メソッド
| Name | 説明 |
|---|---|
| ToJsonString() |
例外のほとんどの値を JSON にシリアル化できます。 (継承元 MsalException) |
| ToString() |
現在の例外の文字列形式を作成して返します。 (継承元 MsalServiceException) |
| UpdateIsRetryable() |
エボ、AADとの議論に従って (継承元 MsalServiceException) |