AcquireTokenForClientParameterBuilder クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Builder for AcquireTokenForClient (クライアント資格情報フロー、デーモン アプリケーションで使用)。 「https://aka.ms/msal-net-client-credentials」を参照してください。
public sealed class AcquireTokenForClientParameterBuilder : Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder>type AcquireTokenForClientParameterBuilder = class
inherit AbstractConfidentialClientAcquireTokenParameterBuilder<AcquireTokenForClientParameterBuilder>Public NotInheritable Class AcquireTokenForClientParameterBuilder
Inherits AbstractConfidentialClientAcquireTokenParameterBuilder(Of AcquireTokenForClientParameterBuilder)- 継承
メソッド
| 名前 | 説明 |
|---|---|
| ExecuteAsync() |
トークン要求を非同期的に実行します。 (継承元 BaseAbstractAcquireTokenParameterBuilder<T>) |
| ExecuteAsync(CancellationToken) |
非同期メソッドを取り消す可能性がある状態で、トークン要求を非同期的に実行します。 (継承元 AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| Validate() |
AcquireToken 操作のパラメーターを検証します。 (継承元 AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithAdfsAuthority(String, Boolean) |
ADFS サーバーに対応する既知の機関を追加します。 https://aka.ms/msal-net-adfsを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAttributes(String) |
トークン要求に含める ID 属性を指定します。 属性値は、アクセス トークン要求の "xms_attr" というトークンの要求として返されます。 これは通常、FMI (フェデレーション マネージド ID) シナリオで使用されます。 属性 json の例: "{"sg1":"0000-00000-0001","sg2":["0000-00000-0002","0000-00000-0003","0000-00000-0004"}" |
| WithAuthority(AadAuthorityAudience, Boolean) |
古い.
重要: 代わりに WithTenantId または WithTenantIdFromAuthority を使用するか、B2C 機関に対して WithB2CAuthority を使用してください。 サインイン対象ユーザー (Azure パブリック クラウドであるクラウド) を指定するサインイン ユーザーに、既知のAzure AD 機関をアプリケーションに追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
古い.
クラウド インスタンスとサインイン対象ユーザーを指定するサインイン ユーザーに、既知のAzure AD 機関をアプリケーションに追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
古い.
重要: 代わりに WithTenantId または WithTenantIdFromAuthority を使用するか、B2C 機関に対して WithB2CAuthority を使用してください。 クラウド インスタンスとそのテナント ID によって記述された単一組織 (シングル テナント アプリケーション) のユーザーをサインインさせるために、アプリケーションに既知のAzure AD 機関を追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, String, Boolean) |
古い.
重要: 代わりに WithTenantId または WithTenantIdFromAuthority を使用するか、B2C 機関に対して WithB2CAuthority を使用してください。 クラウド インスタンスとそのドメイン名またはテナント ID で記述された単一組織 (シングル テナント アプリケーション) のユーザーをサインインさせるために、アプリケーションに既知のAzure AD 機関を追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Boolean) |
古い.
重要: 代わりに WithTenantId または WithTenantIdFromAuthority を使用するか、B2C 機関に対して WithB2CAuthority を使用してください。 トークンが要求される特定の機関。 アプリケーション コンストラクターで構成されている値とは異なる値を渡すと、選択内容が特定のテナントに絞り込まれます。 これにより、アプリケーションで構成された値は変更されません。 これは、複数のアカウント (複数のメールボックスを持つメール クライアントなど) を管理するアプリケーションに固有です。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Guid, Boolean) |
古い.
重要: 代わりに WithTenantId または WithTenantIdFromAuthority を使用するか、B2C 機関に対して WithB2CAuthority を使用してください。 既知の Azure AD 機関をアプリケーションに追加して、そのテナント ID で指定された単一組織 (シングル テナント アプリケーション) のユーザーをサインインさせます。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, String, Boolean) |
古い.
重要: 代わりに WithTenantId または WithTenantIdFromAuthority を使用するか、B2C 機関に対して WithB2CAuthority を使用してください。 ドメイン名で記述された単一の組織 (シングル テナント アプリケーション) のユーザーをサインインさせるために、アプリケーションに既知のAzure AD 機関を追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithAzureRegion(Boolean) |
古い.
ConfidentialClientApplicationBuilder オブジェクトで WithAzureRegion を使用してください |
| WithB2CAuthority(String) |
Azure AD B2C ポリシーに対応する既知の機関を追加します。 「https://aka.ms/msal-net-b2c-specificities」を参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithClaims(String) |
クエリの要求を設定します。 AAD 管理者が条件付きアクセスを有効にした場合に使用します。 通常、トークンを取得すると、MsalUiRequiredException プロパティが設定されたClaimsになります。 トークンの取得を再試行し、 WithClaims(String) メソッドでこの値を使用します。 詳細とhttps://aka.ms/msal-exceptionsについては、https://aka.ms/msal-net-claim-challengeを参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithCorrelationId(Guid) |
認証要求で使用する関連付け ID を設定します。 SDK と ID プロバイダー サービスの両方のログで要求を追跡するために使用されます。 設定されていない場合は、ランダムに生成されます。 (継承元 BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(Dictionary<String,String>) |
古い.
HTTP 認証要求のクエリ文字列の追加クエリ パラメーターを設定します。 (継承元 BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
キャッシュ キーに含めるパラメーターを制御して、HTTP 認証要求のクエリ文字列の追加クエリ パラメーターを設定します (継承元 BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(String) |
古い.
HTTP 認証要求のクエリ文字列の追加クエリ パラメーターを設定します。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithFmiPath(String) |
fmi_path パラメーターを要求に追加します。 トークンのサブジェクトを変更します。 |
| WithForceRefresh(Boolean) |
クライアント アプリケーションがトークン キャッシュの読み取り時にアクセス トークンを無視するかどうかを指定します。 新しいトークンは引き続きアプリケーション トークン キャッシュに書き込まれます。 既定では、トークンはアプリケーション トークン キャッシュから取得されます (forceRefresh=false) |
| WithMtlsProofOfPossession() |
指定された証明書が mTLS (相互 TLS) 認証を使用する PoP トークンに使用されることを指定します。 詳細については、 所有証明のドキュメントを参照してください。 |
| WithPreferredAzureRegion(Boolean, String, Boolean) |
古い.
ConfidentialClientApplicationBuilder オブジェクトで WithAzureRegion を使用してください |
| WithProofOfPossession(PoPAuthenticationConfiguration) |
古い.
取得したトークンがベアラー トークンではなく所有証明トークン (PoP) になるように、トークン取得要求を変更します。 PoP トークンはベアラー トークンに似ていますが、HTTP 要求と暗号化キーにバインドされ、MSAL はWindowsで管理できます。 「https://aka.ms/msal-net-pop」を参照してください。 (継承元 AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithScopes(IEnumerable<String>) |
要求するスコープを指定します。 このメソッドは、アプリケーションが保護された API を呼び出すために必要なスコープを指定する必要がある場合に使用されます。 スコープ、アクセス許可と同意の詳細については、<see>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent</see> に関するページを参照してください。また、OAuth2 アクセス許可を公開するために使用されるレガシ アプリケーションのスコープを作成する方法については>>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes</see<を参照してください。 (継承元 AbstractAcquireTokenParameterBuilder<T>) |
| WithSendX5C(Boolean) |
ファースト パーティのアプリケーションにのみ適用されます。この方法では、x5c 要求を Azure AD に送信するかどうかを指定することもできます。 x5c を送信すると、アプリケーション開発者は、Azure AD で簡単に証明書のロールオーバーを実現できます。この方法では、証明書チェーンをトークン要求と共に Azure AD に送信します。これにより、Azure AD はそれを使用して、信頼された発行者ポリシーに基づいてサブジェクト名を検証できます。 これにより、アプリケーション管理者は証明書のロールオーバーを明示的に管理する必要ができなくなります (ポータルまたは PowerShell/CLI 操作を使用)。 詳細については、以下を参照してください。 https://aka.ms/msal-net-sni |
| WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration) |
ベアラーではなく、署名済み HTTP 要求 (SHR) 所有証明 (PoP) トークンを取得するように要求を変更します。 SHR PoP トークンは HTTP 要求と暗号化キーにバインドされ、MSAL はWindowsで管理します。 SHR PoP トークンは、相互 TLS (mTLS) 認証に使用される mTLS PoP トークンとは異なります。 詳細については、https://aka.ms/mtls-pop を参照してください。 (継承元 AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithTenantId(String) |
アプリケーション レベルで機関で指定されたテナント ID をオーバーライドします。 この操作では、権限ホスト (環境) が保持されます。 権限がアプリケーション・レベルで指定されていない場合、使用されるデフォルトは |
| WithTenantIdFromAuthority(Uri) |
指定された機関 URI からテナント ID を抽出し、アプリケーション レベルで機関で指定されたテナント ID をオーバーライドします。 この操作では、アプリケーション ビルダーに提供された機関ホスト (環境) が保持されます。
権限がアプリケーション ビルダーに提供されていない場合、このメソッドは既定の機関 ( |
拡張メソッド
| 名前 | 説明 |
|---|---|
| OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>) |
MSAL がトークン要求を行う前にユーザー指定のデリゲートを実行することで、要求パイプラインに介入します。 デリゲートは、本文パラメーターとヘッダーを追加または削除することで、要求ペイロードを変更できます。 OnBeforeTokenRequestData |
| WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String) |
構成されたトークンの SHA256 ハッシュと一致する場合に、キャッシュからトークンを取得しないように SDK を構成します。 WithForceRefresh(bool) API と同様ですが、すべてのトークンのキャッシュをバイパスする代わりに、キャッシュ バイパスは 1 つのトークンに対してのみ行われます |
| WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
通常はキャッシュ オブジェクトに含まれていないアクセス トークンを使用してキャッシュされる認証応答から取得される追加のパラメーターを指定します。 これらの値は、 AdditionalResponseParameters パラメーターから読み取ることができます。 |
| WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
|
| WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension) |
クライアント アプリケーションがトークン取得要求で使用するカスタム認証操作を提供できるようにします。 |
| WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String) |
キーと値のペアをクエリ パラメーターとして送信せずに、トークン キャッシュ キーに追加します。
これを使用して、キャッシュされたトークンをパーティション分割します (たとえば、同じユーザーの通常のセッションから有効期間の短いセッションを分離する)。 キャッシュされたエントリを照合するには、 |
| WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String) |
トークン要求に含めるクライアント側の要求を指定します。 WithClaims(String) (サーバーが発行した要求チャレンジの場合) とは異なり、クライアント要求で取得されたトークンはキャッシュされ、キャッシュ エントリは要求値にキーが設定されます。 要求値が異なると、キャッシュ エントリが個別に生成されます。 無制限のキャッシュの増加を回避するには、安定した非動的な値を使用します。 |
| WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>) |
トークン要求に追加の本文パラメーターを追加します。 これらのパラメーターは、これらのパラメーターを取得したトークンに関連付けるためにキャッシュ キーに追加されます。 |
| WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>) |
トークン要求に追加の本文パラメーターを追加します。 これらのパラメーターは、これらのパラメーターを取得したトークンに関連付けるためにキャッシュ キーに追加されます。 機密クライアント フロー (AcquireTokenForClient、AcquireTokenOnBehalfOf、AcquireTokenByAuthorizationCode) で動作します。 |
| WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
クライアント アサーションに含める追加の要求を指定します。 これらの要求は、クライアント アサーションの生成時に既定の要求とマージされます。 これにより、Microsoftなどの上位レベルの API が可能になります。Identity.Web は、クライアント アサーションに追加の要求を提供します。 重要: トークンは、キャッシュ参照に影響を与える追加のクライアント アサーション要求に関連付けられます。 これは拡張 API であり、アプリケーションで直接使用しないでください。 |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
古い.
トークン要求に Http ヘッダーを追加します。 |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
トークン要求に追加の HTTP ヘッダーを追加します。 |
| WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
クライアント アサーションに使用する FMI パスを指定します。 これにより、Id.Web などの上位レベルの API は、FMI の機密性の高い資格情報を提供できます。 重要: トークンは資格情報 FMI パスに関連付けられています。これはキャッシュ参照に影響を与えます。これは拡張 API であり、アプリケーションでは使用しないでください。 |
| WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String) |
トークンをキャッシュ内のキーにバインドします。 L2 キャッシュ キーにはキー ID が含まれています。トークンに対して暗号化操作は実行されません。 |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
トークンをキャッシュ内のキーにバインドします。トークンに対して暗号化操作は実行されません。 |