PublicClientApplicationBuilder クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
public sealed class PublicClientApplicationBuilder : Microsoft.Identity.Client.AbstractApplicationBuilder<Microsoft.Identity.Client.PublicClientApplicationBuilder>type PublicClientApplicationBuilder = class
inherit AbstractApplicationBuilder<PublicClientApplicationBuilder>Public NotInheritable Class PublicClientApplicationBuilder
Inherits AbstractApplicationBuilder(Of PublicClientApplicationBuilder)- 継承
-
PublicClientApplicationBuilder
メソッド
| 名前 | 説明 | |||
|---|---|---|---|---|
| Build() |
IPublicClientApplicationで設定されたパラメーターからPublicClientApplicationBuilderのインスタンスを構築します。 |
|||
| Create(String) |
clientID から PublicClientApplicationBuilder を作成します。 「https://aka.ms/msal-net-application-configuration」を参照してください。 |
|||
| CreateWithApplicationOptions(PublicClientApplicationOptions) |
パブリック クライアント アプリケーション構成オプションから PublicClientApplicationBuilder を作成します。 「https://aka.ms/msal-net-application-configuration」を参照してください。 |
|||
| IsBrokerAvailable() |
ブローカーを使用できる場合は、 |
|||
| WithAdfsAuthority(String, Boolean) |
ADFS サーバーに対応する既知の機関を追加します。 「https://aka.ms/msal-net-adfs」を参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AadAuthorityAudience, Boolean) |
サインイン対象ユーザー (Azure パブリック クラウドであるクラウド) を指定するサインイン ユーザーに、既知のAzure AD 機関をアプリケーションに追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
クラウド インスタンスとサインイン対象ユーザーを指定するサインイン ユーザーに、既知のAzure AD 機関をアプリケーションに追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
クラウド インスタンスとそのテナント ID によって記述された単一組織 (シングル テナント アプリケーション) のユーザーをサインインさせるために、アプリケーションに既知のAzure AD 機関を追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(AzureCloudInstance, String, Boolean) |
クラウド インスタンスとそのドメイン名またはテナント ID によって記述された 1 つの組織 (シングルテナント アプリケーション) のユーザーをサインインさせるために、アプリケーションに既知のAzure AD 機関を追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Boolean) |
完全な権限 URI を指定するサインイン ユーザーに、既知の Azure AD 機関をアプリケーションに追加します。 アプリケーション 構成オプションを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, Guid, Boolean) |
既知の Azure AD 機関をアプリケーションに追加して、そのテナント ID で指定された単一の組織 (シングルテナント アプリケーション) のユーザーをサインインさせます。 アプリケーション 構成オプションを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(String, String, Boolean) |
ドメイン名で記述された 1 つの組織 (シングルテナント アプリケーション) のユーザーをサインインさせるために、アプリケーションに既知のAzure AD 機関を追加します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithAuthority(Uri, Boolean) |
アプリケーションに既知の権限を追加します。 アプリケーション 構成オプションを参照してください。 このコンストラクターは、主に、機関が標準の Azure AD 機関でも ADFS 機関でも、AZURE AD B2C 機関でもないシナリオに使用されます。 Azure AD の場合、ソブリン クラウドでも、次のような他のオーバーライドの使用を優先します。WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) (継承元 AbstractApplicationBuilder<T>) |
|||
| WithB2CAuthority(String) |
Azure AD B2C ポリシーに対応する既知の機関を追加します。 「https://aka.ms/msal-net-b2c-specificities」を参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithBroker(Boolean) | ||||
| WithCacheOptions(CacheOptions) |
MSAL トークン キャッシュのオプション。 MSAL は、トークン キャッシュをメモリ内に内部的に保持します。 既定では、このキャッシュ オブジェクトは、 PublicClientApplication または ConfidentialClientApplicationの各インスタンスの一部です。 このメソッドを使用すると、MSAL のメモリ内トークン キャッシュをカスタマイズできます。 MSAL のメモリ キャッシュは、トークン キャッシュのシリアル化とは異なります。 キャッシュのシリアル化では、キャッシュ (Redis、Cosmos、ディスク上のファイルなど) からトークンがプルされ、JSON 形式で格納され、MSAL の内部メモリ キャッシュに格納されます。 メモリ キャッシュ操作には JSON 操作は含まれません。 外部キャッシュのシリアル化は、永続化を提供するため、デスクトップ アプリ、Web サイト、Web API を処理するための推奨される方法です。 現在、これらのオプションは外部キャッシュのシリアル化を制御しません。 各アプリケーションの種類とプラットフォームの詳細なガイダンス: https://aka.ms/msal-net-token-cache-serialization (継承元 AbstractApplicationBuilder<T>) |
|||
| WithClientCapabilities(IEnumerable<String>) |
Microsoft ID 固有の OIDC 拡張機能を使用すると、対話なしでリソースチャレンジを解決できます。 1 つ以上のクライアント機能の構成を許可します (例: "llt" (継承元 AbstractApplicationBuilder<T>) |
|||
| WithClientId(String) |
アプリケーションのクライアント ID を設定します (継承元 AbstractApplicationBuilder<T>) |
|||
| WithClientName(String) |
テレメトリの目的で呼び出し元の SDK API の名前を設定します。 (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithClientVersion(String) |
テレメトリの目的で呼び出し元 SDK のバージョンを設定します。 (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithDebugLoggingCallback(LogLevel, Boolean, Boolean) |
デバッグ ログ コールバックを、メッセージのレベルとメッセージ自体を表示する既定のデバッグ メソッドに設定します。 詳細については、以下を参照してください。 https://aka.ms/msal-net-logging (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithDefaultRedirectUri() |
プラットフォームに推奨される応答 URI を使用するようにパブリック クライアント アプリケーションを構成します。 https://aka.ms/msal-net-default-reply-uriを参照してください。
|
|||
| WithExperimentalFeatures(Boolean) |
試験的な機能と API の使用を許可します。 このフラグが設定されていない場合、試験的な機能は例外をスローします。 詳細については、以下を参照してください。 https://aka.ms/msal-net-experimental-features (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,String>) |
古い.
HTTP 認証要求のクエリ文字列の追加クエリ パラメーターを設定します。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
キャッシュ キーに含めるパラメーターを制御して、HTTP 認証要求のクエリ文字列の追加クエリ パラメーターを設定します (継承元 AbstractApplicationBuilder<T>) |
|||
| WithExtraQueryParameters(String) |
古い.
HTTP 認証要求のクエリ文字列の追加クエリ パラメーターを設定します。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory, Boolean) |
特定の IMsalHttpClientFactory を使用して IdP と通信します。 これにより、プロキシの設定やエージェントの設定などの高度なシナリオが可能になります。 (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithHttpClientFactory(IMsalHttpClientFactory) |
特定の IMsalHttpClientFactory を使用して IdP と通信します。 これにより、プロキシの設定やエージェントの設定などの高度なシナリオが可能になります。 (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithInstanceDicoveryMetadata(String) |
古い.
開発者が独自の有効な機関を構成できるようにします。 https://aka.ms/aad-instance-discoveryのような json 文字列を指定する必要があります。 MSAL では、次の目的でこの情報が使用されます。
|
|||
| WithInstanceDicoveryMetadata(Uri) |
古い.
組織は、インスタンス検出を処理するように独自のサービスを設定できます。これにより、マイクロサービス/サービス環境のキャッシュが向上します。 https://aka.ms/aad-instance-discoveryのような応答を返す Uri を指定する必要があります。 MSAL では、次の目的でこの情報が使用されます。
|
|||
| WithInstanceDiscovery(Boolean) |
認証を試みるときにインスタンス検出を実行するかどうかを決定します。 これを false に設定すると、インスタンスの検出と機関の検証が完全に無効になります。 ただし、これはリージョン エンドポイントで構成されたアプリケーションの動作には影響しません。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithInstanceDiscoveryMetadata(String) |
開発者が独自の有効な機関を構成できるようにします。 https://aka.ms/aad-instance-discoveryのような json 文字列を指定する必要があります。 MSAL では、次の目的でこの情報が使用されます。
|
|||
| WithInstanceDiscoveryMetadata(Uri) |
組織は、インスタンス検出を処理するように独自のサービスを設定できます。これにより、マイクロサービス/サービス環境のキャッシュが向上します。 https://aka.ms/aad-instance-discoveryのような応答を返す Uri を指定する必要があります。 MSAL では、次の目的でこの情報が使用されます。
|
|||
| WithIosKeychainSecurityGroup(String) |
複数のアプリケーション間でトークン キャッシュを保持するために使用するキーチェーン アクセス グループを指定できます。 これにより、同じキーチェーン アクセス グループを持つ複数のアプリケーション間でトークン キャッシュを共有できます。 トークン キャッシュを共有すると、同じキーチェーン アクセス グループを使用するすべてのアプリケーション間でシングル サインオンが可能になります。 詳細については、https://aka.ms/msal-net-ios-keychain-security-group を参照してください。 |
|||
| WithKerberosTicketClaim(String, KerberosTicketContainer) |
古い.
AZURE AD サービスから Kerberos チケットを取得するために必要なパラメーターを設定します。 |
|||
| WithLegacyCacheCompatibility(Boolean) |
レガシ ADAL キャッシュのシリアル化と逆シリアル化を有効にします。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithLogging(IIdentityLogger, Boolean) |
ID ロガーを設定します。 詳細については、以下を参照してください。 https://aka.ms/msal-net-logging (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>) |
ログ 記録コールバックを設定します。 詳細については、以下を参照してください。 https://aka.ms/msal-net-logging (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithMultiCloudSupport(Boolean) |
パブリック クライアント アプリケーションのこのインスタンスに対するマルチ クラウド サポートを有効にします。 これにより、アプリケーションはライブラリに対するグローバル パブリック クラウド機関で使用でき、ソブリン クラウドからリソースのトークンを取得できます。 |
|||
| WithOidcAuthority(String) |
汎用 OpenIdConnect ID プロバイダーに対応する既知の機関を追加します。 MSAL は、".well-known/openid-configuration" を機関に追加し、そこから OIDC メタデータを取得してエンドポイントを特定します。 「https://openid.net/specs/openid-connect-core-1_0.html#Terminology」を参照してください。 |
|||
| WithOptions(ApplicationOptions) |
たとえば、構成ファイルから読み取られたアプリケーション オプションを設定します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithOptions(BaseApplicationOptions) |
たとえば、構成ファイルから読み取られたアプリケーション オプションを設定します。 https://aka.ms/msal-net-application-configurationを参照してください。 (継承元 BaseAbstractApplicationBuilder<T>) |
|||
| WithParentActivityOrWindow(Func<IntPtr>) |
IntPtr への参照を、表示するブラウザーをトリガーするウィンドウに設定します。 このウィンドウにポップアップ表示されるブラウザーを中央に配置するために使用します。 |
|||
| WithParentActivityOrWindow(Func<Object>) |
ViewController (iOS を使用している場合)、アクティビティ (Android を使用している場合) IWin32Window または IntPtr (.Net Framework を使用している場合) への参照を設定します。 ブラウザーの呼び出しに使用されます。 |
|||
| WithRedirectUri(String) |
アプリケーションのリダイレクト URI を設定します。 URI は、アプリケーション ポータルにも登録する必要があります。 「https://aka.ms/msal-net-application-configuration」を参照してください。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithTelemetry(ITelemetryConfig) |
古い.
テレメトリ集計イベントを生成します。 (継承元 AbstractApplicationBuilder<T>) |
|||
| WithTenantId(String) |
アプリケーションがユーザーのサインインを許可する組織のテナント ID を設定します。 これは、従来は GUID またはドメイン名です。
https://aka.ms/msal-net-application-configurationを参照してください。
|
|||
| WithWindowsBrokerOptions(WindowsBrokerOptions) |
古い.
Windows 10 Broker エクスペリエンスのカスタマイズを許可します。 |
|||
拡張メソッド
| 名前 | 説明 |
|---|---|
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
ブローカーは、シングル サインオン、デバイス識別、アプリケーション識別検証を有効にしながら、アプリケーションのセキュリティを強化します。 この API を使用して、デスクトップ プラットフォームでブローカーを有効にします。 リダイレクト URI などのブローカーを有効にするために必要なプラットフォーム固有の設定の詳細については、 https://aka.ms/msal-net-wam を参照してください。 |
| WithBroker(PublicClientApplicationBuilder, BrokerOptions) |
ブローカーは、シングル サインオン、デバイス識別、およびセキュリティ強化を有効にします。 この API を使用して、デスクトップ プラットフォームでブローカーを有効にします。 リダイレクト URI などのブローカーを有効にするために必要なプラットフォーム固有の設定の詳細については、 https://aka.ms/msal-net-wam を参照してください。 |
| WithBrokerPreview(PublicClientApplicationBuilder, Boolean) |
古い.
MSAL でブローカー フローを使用できるようにします。これは、ブラウザーよりも安全です。 Windowsブローカーの詳細については、以下を参照してください。https://aka.ms/msal-net-wam |
| WithDesktopFeatures(PublicClientApplicationBuilder) |
古い.
CLI、WinForms、WPF アプリなど、デスクトップ アプリケーションのサポートが強化されました。 追加されるサポートは次のとおりです。
|
| WithSsoPolicy(PublicClientApplicationBuilder) |
SsoPolicy の適用を有効にするには、この API を使用します。 Microsoftファースト パーティ アプリケーションでのみ使用する必要があります。 これは、ブローカーが有効ではなく、埋め込み Web ビューが推奨される場合にのみ適用されます。 既定では、ブローカーは SsoPolicy をサポートし、システム Webview SsoPolicy も OS レベルでサポートされます。 |
| WithWindowsBroker(PublicClientApplicationBuilder, Boolean) |
古い.
.NET フレームワークなど、Windows古いプラットフォームでブローカー フローを有効にします。Microsoftボックスでは使用できません。Identity.Client Windowsブローカーの詳細については、https://aka.ms/msal-net-wam |
| WithWindowsDesktopFeatures(PublicClientApplicationBuilder, BrokerOptions) |
CLI、WinForms、WPF アプリなど、デスクトップ アプリケーションのサポートが強化されました。
|
| WithWindowsEmbeddedBrowserSupport(PublicClientApplicationBuilder) |
MSAL により、より優れた埋め込みブラウザーのサポートが追加されます。 AAD アプリケーションでは、古い WebBrowser コントロールが使用されます。 他のアプリケーション (B2C、ADFS など) では、Microsoft Edgeに基づいて埋め込みブラウザーが使用されます。https://aka.ms/msal-net-webview2 |