Microsoft.Identity.Client 名前空間
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Microsoft.Identity.Clientは、Microsoft.Identity.Client パッケージを介して使用できる、.NETのMicrosoft Authentication Library (MSAL) のコア名前空間です。 これには、サポートされている認証プロバイダーからトークンを取得するために必要なすべての主要なコンポーネントが含まれています。
Installation
.NET Command-Line インターフェイス (CLI) の使用:
dotnet add package Microsoft.Identity.Client
NuGet コマンド ライン インターフェイス (CLI) の使用:
nuget install Microsoft.Identity.Client
Install-Package Microsoft.Identity.Client
Visual Studioの使用:
- ソリューション エクスプローラーを開きます。
- ソリューション内のプロジェクトを右クリックします。
- [ NuGet パッケージの管理]をクリックします。..
- [参照] タブをクリックし、
Microsoft.Identity.Clientを検索します。 -
Microsoft.Identity.Clientパッケージをクリックし、[インストール] をクリックします。
ドキュメンテーション
開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。
Samples
Microsoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。
クラス
| 名前 | 説明 |
|---|---|
| AbstractAcquireTokenParameterBuilder<T> |
指定されたパラメーターに基づいてトークンを取得しようとするトークン要求のビルダーの基本クラス。 |
| AbstractApplicationBuilder<T> |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| AbstractClientAppBaseAcquireTokenParameterBuilder<T> |
パブリック クライアント アプリケーションと機密クライアント アプリケーション トークン取得操作に共通するパラメーター ビルダーの基本クラス |
| AbstractConfidentialClientAcquireTokenParameterBuilder<T> |
機密クライアント アプリケーション トークン要求ビルダーの基本クラス |
| AbstractManagedIdentityAcquireTokenParameterBuilder<T> |
マネージド ID アプリケーション トークン要求ビルダーの抽象基本クラス。 |
| AbstractPublicClientAcquireTokenParameterBuilder<T> |
パブリック クライアント アプリケーション トークン要求ビルダーの基本クラス |
| AccountExtensions |
の拡張メソッド IAccount |
| AccountId |
特定のテナント内のアカウントの識別子。 戻り値: IAccount.HomeAccountId |
| AcquireTokenByAuthorizationCodeParameterBuilder |
AcquireTokenByAuthorizationCode の Builder |
| AcquireTokenByIntegratedWindowsAuthParameterBuilder |
AcquireTokenByIntegratedWindowsAuth のビルダー |
| AcquireTokenByRefreshTokenParameterBuilder |
AcquireTokenByRefreshToken(IEnumerable<String>, String) メソッドのパラメーター ビルダー。 「https://aka.ms/msal-net-migration-adal2-msal2」を参照してください。 |
| AcquireTokenByUserFederatedIdentityCredentialParameterBuilder |
AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, String, String)操作のパラメーター ビルダー。 |
| AcquireTokenByUsernameAndPasswordConfidentialParameterBuilder |
AcquireTokenByUsernamePassword(IEnumerable<String>, String, String)操作のパラメーター ビルダー。 「https://aka.ms/msal-net-up」を参照してください。 |
| AcquireTokenByUsernamePasswordParameterBuilder |
AcquireTokenByUsernamePassword(IEnumerable<String>, String, String)操作のパラメーター ビルダー。 「https://aka.ms/msal-net-up」を参照してください。 |
| AcquireTokenForClientParameterBuilder |
Builder for AcquireTokenForClient (クライアント資格情報フロー、デーモン アプリケーションで使用)。 「https://aka.ms/msal-net-client-credentials」を参照してください。 |
| AcquireTokenForManagedIdentityParameterBuilder |
Builder for AcquireTokenForManagedIdentity (マネージド ID のトークンを取得するために使用されます)。 「https://aka.ms/msal-net-managed-identity」を参照してください。 |
| AcquireTokenInteractiveParameterBuilder |
対話型トークン要求のビルダー。 「https://aka.ms/msal-net-acquire-token-interactively」を参照してください。 |
| AcquireTokenOnBehalfOfParameterBuilder |
Builder for AcquireTokenOnBehalfOf (OBO フロー) を参照 https://aka.ms/msal-net-on-behalf-of |
| AcquireTokenSilentParameterBuilder |
AcquireTokenSilent(IEnumerable<String>, IAccount)操作のパラメーター ビルダー。 「https://aka.ms/msal-net-acquiretokensilent」を参照してください。 |
| AcquireTokenWithDeviceCodeParameterBuilder |
AcquireTokenWithDeviceCode(IEnumerable<String>, Func<DeviceCodeResult,Task>)操作のパラメーター ビルダー。 「https://aka.ms/msal-net-device-code-flow」を参照してください。 |
| ApplicationBase |
クライアント アプリケーションの作成に使用されるインターフェイス。 詳細については、「 https://aka.ms/msal-net-client-applications」を参照してください。 |
| ApplicationOptions |
構成ファイルから読み込み可能な文字列値を持つオプション オブジェクトの基本クラス (asp.net 構成シナリオのように JSON ファイルなど) については、「 https://aka.ms/msal-net-application-configuration 派生クラスの PublicClientApplicationOptions と ConfidentialClientApplicationOptions |
| AssertionRequestOptions |
生成する必要があるクライアント アサーションに関する情報 https://aka.ms/msal-net-client-assertion |
| AuthenticationHeaderParser |
HttpResponseHeadersからヘッダー値を取得するために解析された認証ヘッダー。 |
| AuthenticationInfoParameters |
Authentication-Info ヘッダーによって返されるパラメーター。 これにより、所有証明などのシナリオが可能になります。参照 https://www.rfc-editor.org/rfc/rfc7615 |
| AuthenticationResult |
PublicClientApplicationまたは ConfidentialClientApplication での 1 つのトークン取得操作の結果を格納します。 詳細については、以下を参照してください。 https://aka.ms/msal-net-authenticationresult |
| AuthenticationResultMetadata |
認証結果のメタデータが含まれています。 Metrics 追加の MSAL 全体のメトリック。 |
| BaseAbstractAcquireTokenParameterBuilder<T> |
指定されたパラメーターに基づいてトークンを取得しようとするトークン要求のビルダーの基本クラス。 |
| BaseAbstractApplicationBuilder<T> |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| BaseApplicationOptions |
構成ファイルから読み込み可能な文字列値を持つオプション オブジェクトの基本クラス (asp.net 構成シナリオのように JSON ファイルなど) については、「 https://aka.ms/msal-net-application-configuration 派生クラスも参照してください。 ApplicationOptions |
| BrokerOptions |
このクラスは、OperatingSystems 全体のブローカーのオプションを指定します。共通プロパティは、直接メンバーであるプラットフォーム固有のプロパティ (存在する場合) は、対応するオプションの一部です |
| CacheOptions |
MSAL トークン キャッシュのオプション。 |
| ClientApplicationBase |
一般的な API メソッドとプロパティを含む抽象クラス。 PublicClientApplicationと ConfidentialClientApplication の両方で、このクラスが拡張されます。 詳細については、以下を参照してください。 https://aka.ms/msal-net-client-applications |
| ClientSignedAssertion |
|
| ConfidentialClientApplication |
機密クライアント アプリケーション (Web アプリ、Web API、デーモン アプリケーション) に使用するクラス。 |
| ConfidentialClientApplicationBuilder |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| ConfidentialClientApplicationOptions |
機密クライアント アプリケーション (Web アプリ/Web API/デーモン アプリ) の構成オプション。 「https://aka.ms/msal-net/application-configuration」を参照してください。 |
| DeviceCodeResult |
このオブジェクトはデバイス コード フローの一部として返され、ログインに移動する場所とそのデバイスで入力する必要があるデバイス コードに関する情報がユーザーに表示されます。 https://aka.ms/msal-device-code-flowを参照してください。 |
| EmbeddedWebViewOptions |
埋め込み Web ビューを使用するためのオプション。 |
| GetAuthorizationRequestUrlParameterBuilder |
注: AbstractAcquireTokenParameterBuilder (アカウントなど) のメソッドの一部は、ここでは意味がありません。 すべての一般的なメソッドを含むさらにベースを作成し、AcquireToken にのみ使用されるアカウントなどを含む別のベースを作成しますか? |
| IntuneAppProtectionPolicyRequiredException |
この例外は、Intune でアプリ保護ポリシーが必要な場合にスローされます。 この例外の情報は、アプリがモバイル アプリ管理 (MAM) SDK から必要な登録 ID を取得するために使用できます。 「https://aka.ms/msal-net-trueMAM」を参照してください。 |
| ManagedIdentityApplication |
マネージド ID アプリケーションに使用するクラス (App Services、Virtual Machines、Azure Arc、サービス Fabric、Cloud ShellなどのAzure リソース上)。 |
| ManagedIdentityApplicationBuilder |
マネージド ID アプリケーションのビルダー。 |
| ManagedIdentityPopExtensions |
マネージド ID フローで mTLS Proof-of-Possession を有効にする拡張メソッド。 |
| Metrics |
MSAL 全体のメトリック。 |
| MsalClaimsChallengeException |
この例外は、解決する必要があるエンドポイントから要求が返されたことを示します。 これを実現するには、次の認証要求でそれらを使用します。 条件付きアクセスと要求チャレンジを参照してください。 多要素認証 (MFA)、条件付きアクセス、増分同意の処理に関するページを参照してください。 |
| MsalClientException |
この例外クラスは、ライブラリまたはデバイスに対してローカルなエラーを表します。 Azure AD サービスまたはネットワークから発生するエラーを表すMsalServiceExceptionとは対照的です。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください |
| MsalError |
MsalException でプロパティとして返されるエラー コード |
| MsalException |
トークンの取得中にエラーが発生したときにスローされる基本例外の種類。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください |
| MsalManagedIdentityException |
この例外クラスは、マネージド ID ソースから生成された例外を対象としています。 このクラスは非推奨であり、今後のリリースで削除される予定です。 代わりに MsalServiceException をキャッチします。 詳細については、https://aka.ms/msal-net-managed-identity をご覧ください |
| MsalServiceException |
サービスがエラー応答またはその他のネットワーク エラーを返したときにスローされる例外の種類。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください |
| MsalThrottledServiceException |
次の結果として、アプリケーションがトークンを取得しようとしていることが MSAL によって検出されたときにスローされる例外の種類。
この例外のプロパティは、元の例外と同じです 詳細については、以下を参照してください。 https://aka.ms/msal-net-throttling |
| MsalThrottledUiRequiredException |
が最近スローされた場合でも、アプリケーションがトークンを取得しようとしていることが MSAL によって検出されたときにスローされる例外の種類。 これを軽減するには、 MsalUiRequiredException が発生したときに、アプリケーションが対話形式でトークンの取得に切り替える必要があります。 MsalUiRequiredExceptionがスローされた理由を理解するには、Classification プロパティを調べます。 この例外のプロパティは、元の例外と同じです 詳細については、以下を参照してください。 https://aka.ms/msal-net-throttling |
| MsalUiRequiredException |
この例外クラスは、認証を成功させるために UI 操作が必要であることを開発者に通知することです。 これは、AcquireTokenSilent(IEnumerable<String>, IAccount)またはそのオーバーライドの呼び出し時、トークンがキャッシュに存在しない場合、またはユーザーがより多くのコンテンツを提供する必要がある場合や、Azure AD ポリシーなどに基づいて多要素認証を実行する必要がある場合にスローされます。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください |
| OsCapabilitiesExtensions |
拡張メソッド |
| PublicClientApplication |
一般的な API メソッドとプロパティを含む抽象クラス。 詳細については、以下を参照してください。 https://aka.ms/msal-net-client-applications |
| PublicClientApplicationBuilder |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| PublicClientApplicationExtensions |
の拡張メソッド IPublicClientApplication |
| PublicClientApplicationOptions |
パブリック クライアント アプリケーション (デスクトップ/モバイル アプリ) の構成オプション。 「https://aka.ms/msal-net/application-configuration」を参照してください。 |
| RegionDetails |
AUTHENTICATIONResultMetadata の一部として発行された、MSAL リージョン検出が使用されたときのリージョンの結果を格納します。 AuthenticationResultMetadata 認証結果の追加のメタデータ情報。 |
| SystemWebViewOptions |
対話型認証を処理するための別のプロセスとして既定の OS ブラウザーを使用するためのオプション。MSAL は OS ブラウザーの認証が完了するのをリッスンしますが、ブラウザーを閉じることはできません。 ただし、ここで構成できる 200 OK メッセージまたは 302 リダイレクトで応答できます。 詳細については、以下を参照してください。 https://aka.ms/msal-net-os-browser |
| TenantProfile |
特定のテナント内のアカウントを表します。 同じアカウントは、そのホーム テナントに存在することも、他の複数のテナントのゲストとして存在することもできます。 アクセス トークンと ID トークンはテナント固有であり、このオブジェクトは、アカウントに関連付けられているすべての ID トークンに関する高レベルの情報を提供します。 |
| TokenCache |
アカウントのアクセス トークンと更新トークンを格納するトークン キャッシュこのクラスは、 PublicClientApplication および ConfidentialClientApplicationのコンストラクターで使用されます。 ConfidentialClientApplication の場合、2 つのインスタンスが使用されます。1 つはユーザー トークン キャッシュ用、1 つはアプリケーション トークン キャッシュ用です (クライアント資格情報フローを使用するアプリケーションの場合)。 |
| TokenCacheExtensions |
ITokenCache の拡張メソッド |
| TokenCacheNotificationArgs |
キャッシュにアクセスする MSAL 呼び出しで使用されるパラメーターが含まれます。 キャッシュのシリアル化をカスタマイズするメソッドを含む ITokenCacheSerializer も参照してください。 トークン キャッシュの詳細については、次を参照してください。 https://aka.ms/msal-net-web-token-cache |
| TraceTelemetryConfig |
System.Diagnostics.Trace を使用してデータを書き込む単純な ITelemetryConfig 実装。 |
| UserAssertion |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| WindowsBrokerOptions |
Windows 10 ブローカーを使用するための高度なオプション。 詳細については、以下を参照してください。 https://aka.ms/msal-net-wam |
| WwwAuthenticateParameters |
WWW-Authenticate ヘッダーによって返されるパラメーター。 これにより、要求チャレンジ、継続的アクセス評価 (CAE)、条件付きアクセス (CA) などの動的なシナリオが可能になります。 https://aka.ms/msal-net/wwwAuthenticateを参照してください。 |
構造体
| 名前 | 説明 |
|---|---|
| Prompt |
IPublicClientApplicationの AcquireTokenAsync の対話型オーバーライドでユーザーにプロンプトを表示する方法を指定するために使用できる静的メンバーを含む構造体。 |
インターフェイス
| 名前 | 説明 |
|---|---|
| IAccount |
IAccount インターフェイスは、1 つのアカウントに関する情報を表します。
同じユーザーを異なるテナントに存在させることができます。つまり、1 人のユーザーが複数のアカウントを持つことができます。
|
| IAppConfig |
パブリック クライアント アプリケーションまたは機密クライアント アプリケーションの構築に使用される構成プロパティ。 |
| IApplicationBase |
クライアント アプリケーションの作成に使用されるインターフェイス。 詳細については、「 https://aka.ms/msal-net-client-applications」を参照してください。 |
| IByRefreshToken |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| IByUserFederatedIdentityCredential |
ユーザー フェデレーション ID 資格情報 (UserFIC) フローを使用してトークンを取得するためのインターフェイスを提供します。 |
| IByUsernameAndPassword |
Confidential Client でリソース所有者パスワード付与を使用するための明示的なインターフェイスを提供します。 |
| IClientApplicationBase |
一般的な API メソッドとプロパティを定義するインターフェイス。 PublicClientApplicationとConfidentialClientApplicationの両方がこのクラスを拡張します。 詳細については、以下を参照してください。 https://aka.ms/msal-net-client-applications |
| IConfidentialClientApplication |
機密クライアント アプリケーション (Web アプリ、Web API、デーモン アプリケーション) を表します。 |
| ILongRunningWebApi |
Web API での実行時間の長いプロセスまたはバックグラウンド プロセスのメソッド。 |
| IManagedIdentityApplication |
Azure リソースのマネージド ID アプリケーションで使用されるコンポーネント。 |
| IMsalHttpClientFactory |
HttpClient の作成を担当するファクトリ。 詳細については、 https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing をご覧ください。 |
| IMsalMtlsHttpClientFactory |
相互 TLS (mTLS) 用に構成された HttpClient インスタンスの作成を担当するファクトリ。 このファクトリは、mTLS を使用して Azure AD との通信をセキュリティで保護するために使用されます。 HttpClient インスタンス化の詳細については、 https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-8.0#instancingを参照してください。 |
| IMsalSFHttpClientFactory |
カスタム サーバー証明書検証コールバックを使用して HttpClient を作成するファクトリ。 これは、サーバー証明書を使用してサーバー証明書の検証が必要なサービス Fabric シナリオに役立ちます。詳細については、https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancingを参照してください。 |
| IPublicClientApplication |
パブリック クライアント アプリケーション (デスクトップ アプリケーションとモバイル アプリケーション) を表します。 |
| ITelemetryConfig |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| ITelemetryEventPayload |
収集される一連のイベントの 1 つのスナップショットを表すデータ |
| ITokenCache |
これは、キャッシュ操作へのパブリック アクセスを実装するインターフェイスです。 CacheV2 では、呼び出し元が独自のストアにキャッシュを保持している場合にのみ必要です。これは、そのシナリオで使用されるシリアル化/逆シリアル化および前後の通知を提供するためです。 「https://aka.ms/aka.ms/msal-net-token-cache-serialization」を参照してください。 |
| ITokenCacheSerializer |
このインターフェイスは、キャッシュのシリアル化/逆シリアル化を有効にするために TokenCacheNotificationArgs コールバックで使用できます。 |
列挙型
| 名前 | 説明 |
|---|---|
| AadAuthorityAudience |
特定のアプリケーションでのサインインに使用できるMicrosoft アカウントを指定します。 「https://aka.ms/msal-net-application-configuration」を参照してください。 |
| AzureCloudInstance |
Installation.NET Command-Line インターフェイス (CLI) の使用: NuGet コマンド ライン インターフェイス (CLI) の使用: Visual Studioの使用:
ドキュメンテーション開始するには、.NET ガイドのMicrosoft Authentication Libraryを確認してください。 SamplesMicrosoft ID プラットフォームコード サンプルとサンプル ブラウザーを参照してください。 |
| BrokerOptions.OperatingSystems |
サポートされている OperatingSystems |
| CacheRefreshReason |
AcquireTokenSilent、AcquireTokenForClient、または AcquireTokenOnBehalfOf を使用するときに、ID プロバイダーからアクセス トークンをフェッチする理由を指定します。 |
| LogLevel |
MSAL のログ レベルを表します。 詳細については、 MSAL のログ記録に関するページを参照してください。 |
| TelemetryAudienceType |
テレメトリの対象ユーザーの種類について説明します。 AudienceType |
| TokenSource |
認証結果のアクセス トークンと ID トークンのソースを指定します。 |
| UiRequiredExceptionClassification |
MsalUiRequiredExceptionの原因の詳細。ユーザーが対話型認証を行うときにユーザーが期待できることを示すヒントを提供します。 詳細については、「 MsalUiRequiredException について」を参照してください。 |
代理人
| 名前 | 説明 |
|---|---|
| LogCallback |
アプリケーション開発者がログを使用し、それらをカスタムの方法で処理できるようにするコールバック デリゲート。 このコールバックは、 WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>)を使用して設定されます。
|
| TokenCacheCallback |
トークンの取得中の特定のトークン キャッシュの相互作用に関する通知。 このデリゲートは、特にカスタム トークン キャッシュのシリアル化を提供するために使用されます。 「https://aka.ms/aka.ms/msal-net-token-cache-serialization」を参照してください。 |
注釈
貢献
.NETのMicrosoft Authentication Library向上に役立つフィードバックと投稿をお待ちしております。 作業を開始する前に、次のドキュメントをお読みください。
課題
ライブラリのフィードバックを提供したり、バグを報告したりするには、GitHubで問題を開いてください。