ConfidentialClientApplication クラス

定義

名前空間:: Microsoft.Identity.Client

アセンブリ:: Microsoft.Identity.Client.dll

パッケージ:: Microsoft.Identity.Client v4.84.2

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

機密クライアントアプリケーション (Web アプリ、Web API、デーモンアプリケーション) に使用するクラス。

public sealed class ConfidentialClientApplication : Microsoft.Identity.Client.ClientApplicationBase, Microsoft.Identity.Client.IByRefreshToken, Microsoft.Identity.Client.IByUsernameAndPassword, Microsoft.Identity.Client.IConfidentialClientApplication, Microsoft.Identity.Client.ILongRunningWebApi

type ConfidentialClientApplication = class
    inherit ClientApplicationBase
    interface IConfidentialClientApplication
    interface IClientApplicationBase
    interface IApplicationBase
    interface IByUserFederatedIdentityCredential
    interface IByRefreshToken
    interface ILongRunningWebApi
    interface IByUsernameAndPassword

Public NotInheritable Class ConfidentialClientApplication
Inherits ClientApplicationBase
Implements IByRefreshToken, IByUsernameAndPassword, IConfidentialClientApplication, ILongRunningWebApi

継承: Object

ApplicationBase

ClientApplicationBase
ConfidentialClientApplication

実装: IApplicationBase IByRefreshToken IByUserFederatedIdentityCredential IByUsernameAndPassword IClientApplicationBase IConfidentialClientApplication ILongRunningWebApi

注釈

機密クライアントアプリケーションは、通常、サーバー (Web アプリ、Web API、さらにはサービス/デーモンアプリケーション) で実行されるアプリケーションです。アクセスが困難であると見なされるため、アプリケーションシークレットを保持できます (これらの値をエンドユーザーが抽出するのが困難であるため、構成時のシークレットを保持します)。 Web アプリは、最も一般的な機密クライアントです。 clientId は Web ブラウザーを介して公開されますが、シークレットはバックチャネルでのみ渡され、直接公開されることはありません。詳細については、以下を参照してください。 https://aka.ms/msal-net-client-applications

フィールド

名前	説明
AttemptRegionDiscovery	Azure リージョンの自動検出を試行するように MSAL に指示します。

プロパティ

名前	説明
AppConfig	デバッグ目的での ClientApplication の構成の詳細。 (継承元 ClientApplicationBase)
AppTokenCache	アプリケーショントークンキャッシュ。このケースでは、アプリケーションのアクセストークンが保持されます。呼び出し時に必要に応じて、メンテナンスと更新が自動的に行われます AcquireTokenForClient(IEnumerable<String>)
Authority	MSAL.NET がセキュリティトークンを取得する機関またはセキュリティトークンサービス (STS) の URL を取得します。このプロパティの戻り値は、アプリケーションのコンストラクターで開発者が指定した値か、それ以外の場合はMicrosoft.Identity.Client.ApplicationBase.DefaultAuthority静的メンバーの値 (`https://login.microsoftonline.com/common/`) です。 (継承元 ClientApplicationBase)
Certificate	この ConfidentialClientApplicationの作成に使用する証明書 (存在する場合)。
UserTokenCache	ユーザートークンキャッシュ。アカウントのアクセストークン、ID トークン、更新トークンが保持されます。 AcquireTokenSilent(IEnumerable<String>, IAccount)の呼び出し時またはAcquireTokenSilent(IEnumerable<String>, IAccount)のオーバーライドの 1 つを呼び出すときに、必要に応じて自動的に使用および更新されます。アプリケーションキャッシュのみを使用する `AcquireTokenForClient` を除き、各 AcquireTokenXXX メソッドによって更新されます ( `IConfidentialClientApplication`を参照)。 (継承元 ClientApplicationBase)

メソッド

名前	説明
AcquireTokenByAuthorizationCode(IEnumerable<String>, String)	STS から以前に受信した承認コードを使用して、アプリで構成された機関からセキュリティトークンを取得します。 OAuth 2.0 承認コードフローを使用します ( https://aka.ms/msal-net-authorization-codeを参照)。これは通常、ユーザーをサインインさせる Web アプリ (ASP.NET/ASP.NET Core Web アプリなど) で使用され、承認コードを要求できます。このメソッドはトークンキャッシュを参照しませんが、結果を格納するため、 AcquireTokenSilent(IEnumerable<String>, IAccount)などの他のメソッドを使用して検索できます。
AcquireTokenForClient(IEnumerable<String>)	クライアント資格情報フローを使用して、機密クライアント自体 (ユーザーなしの名前) に対して、アプリで構成された機関からトークンを取得します。 https://aka.ms/msal-net-client-credentialsを参照してください。
AcquireTokenInLongRunningProcess(IEnumerable<String>, String)	OAuth 2.0 On-Behalf-Of フローを使用して、ユーザーの代わりにダウンストリームで保護された別の Web API にアクセスするために使用できる、指定されたキャッシュキーを使用して、キャッシュからアクセストークンを取得します。 MSAL.NET で実行時間の長い OBO を参照してください。 <seealso cref="M:Microsoft を使用します。Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"></seealso> 実行時間の長いプロセスを停止し、関連するトークンをキャッシュから削除します。
AcquireTokenOnBehalfOf(IEnumerable<String>, UserAssertion)	OAuth 2.0 On-Behalf-Of フローを使用して、ユーザーの代わりにダウンストリームで保護された別の Web API にアクセスするために、アプリケーションで構成された機関からこのアプリケーション (通常は Web API) のアクセストークンを取得します。 https://aka.ms/msal-net-on-behalf-ofを参照してください。この機密クライアントアプリケーション自体は、 `userAssertion` パラメーターで提供されるトークンを使用して呼び出されました。
AcquireTokenSilent(IEnumerable<String>, IAccount)	[V3 API]ユーザートークンキャッシュから `account` のアクセストークンの取得を試みます。詳細については、 https://aka.ms/msal-net-acquiretokensilent を参照してください (継承元 ClientApplicationBase)
AcquireTokenSilent(IEnumerable<String>, String)	[V3 API]Usernameが特定の`loginHint`と一致するIAccountのアクセストークンをユーザートークンキャッシュから取得しようとします。詳細については、 https://aka.ms/msal-net-acquiretokensilent を参照してください (継承元 ClientApplicationBase)
GetAccountAsync(String, CancellationToken)	トークンキャッシュで使用可能なアカウントの識別子によって IAccount を取得します。 (継承元 ClientApplicationBase)
GetAccountAsync(String)	トークンキャッシュで使用可能なアカウントの識別子によって IAccount を取得します。 (継承元 ClientApplicationBase)
GetAccountsAsync()	アプリケーションのユーザートークンキャッシュで使用可能なすべてのアカウントを返します。 (継承元 ClientApplicationBase)
GetAccountsAsync(CancellationToken)	アプリケーションのユーザートークンキャッシュで使用可能なすべてのアカウントを返します。 (継承元 ClientApplicationBase)
GetAccountsAsync(String, CancellationToken)	ユーザーフローに基づいて、トークンキャッシュで使用可能なアカウントの識別子によって、 IAccount コレクションを取得します。これは、Azure AD B2C シナリオ用です。 (継承元 ClientApplicationBase)
GetAccountsAsync(String)	ユーザーフローに基づいて、トークンキャッシュで使用可能なアカウントの識別子によって、 IAccount コレクションを取得します。これは、Azure AD B2C シナリオ用です。 (継承元 ClientApplicationBase)
GetAuthorizationRequestUrl(IEnumerable<String>)	承認要求の URL を計算して、ユーザーがサインインし、ユーザー名の特定のスコープにアクセスするアプリケーションに同意します。 URL は、アプリケーションで構成された機関の /authorize エンドポイントを対象とします。このオーバーライドを使用すると、ログインヒントと追加のクエリパラメーターを指定できます。
InitiateLongRunningProcessInWebApi(IEnumerable<String>, String, String)	OAuth 2.0 On-Behalf-Of フローを使用して、ユーザーの代わりにダウンストリームで保護された別の Web API にアクセスするために、アプリケーションで構成された機関からこの Web API のアクセストークンを取得します。 MSAL.NET で実行時間の長い OBO を参照してください。 `userToken` パラメーターでこの機密クライアントアプリケーションを呼び出すために使用されたアクセストークン (ID トークンではありません) を渡します。 <seealso cref="M:Microsoft を使用します。Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"></seealso> 実行時間の長いプロセスを停止し、関連するトークンをキャッシュから削除します。
RemoveAsync(IAccount, CancellationToken)	指定したアカウントのキャッシュ内のすべてのトークンを削除します。 (継承元 ClientApplicationBase)
RemoveAsync(IAccount)	指定したアカウントのキャッシュ内のすべてのトークンを削除します。 (継承元 ClientApplicationBase)
StopLongRunningProcessInWebApiAsync(String, CancellationToken)	提供されたキャッシュキーに関連付けられているトークンを削除して、進行中の実行時間の長い on-behalf-of セッションを停止します。 MSAL.NET で実行時間の長い OBO を参照してください。

明示的なインターフェイスの実装

名前	説明
IByRefreshToken.AcquireTokenByRefreshToken(IEnumerable<String>, String)	機密クライアントアプリケーション (Web アプリ、Web API、デーモンアプリケーション) に使用するクラス。
IByUserFederatedIdentityCredential.AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, Guid, String)	フェデレーション ID 資格情報アサーションを使用して、ユーザーに代わってトークンを取得します。これにより、 `user_fic` 許可の種類が使用されます。ユーザーはオブジェクト ID (OID) で識別されます。
IByUserFederatedIdentityCredential.AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, String, String)	フェデレーション ID 資格情報アサーションを使用して、ユーザーに代わってトークンを取得します。これにより、 `user_fic` 許可の種類が使用されます。ユーザーは UPN によって識別されます。
IByUsernameAndPassword.AcquireTokenByUsernamePassword(IEnumerable<String>, String, String)	ユーザー名とパスワード認証を使用して、ユーザー操作なしでトークンを取得します。このメソッドはトークンキャッシュを検索しませんが、結果を格納します。このメソッドを呼び出す前に、 AcquireTokenSilent(IEnumerable<String>, IAccount) などの他のメソッドを使用してトークンキャッシュを確認します。

拡張メソッド

名前	説明
GetCertificate(IConfidentialClientApplication)	この ConfidentialClientApplicationの作成に使用した証明書 (存在する場合) を返します。
StopLongRunningProcessInWebApiAsync(ILongRunningWebApi, String, CancellationToken)	提供されたキャッシュキーに関連付けられているトークンを削除して、進行中の実行時間の長い on-behalf-of セッションを停止します。 MSAL.NET で実行時間の長い OBO を参照してください。

適用対象

フィードバック

このページはお役に立ちましたか?