BrokerExtension.WithBrokerPreview Method

Reference

Definition

Namespace:: Microsoft.Identity.Client.Broker

Assembly:: Microsoft.Identity.Client.Broker.dll

Package:: Microsoft.Identity.Client.Broker v4.60.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

This broker implementation is generally available. Use WithBroker(BrokerOptions) in Microsoft.Identity.Client.Broker package instead. See https://aka.ms/msal-net-wam for details.

Enables MSAL to use Broker flows, which are more secure than browsers. For details about Windows broker, see https://aka.ms/msal-net-wam

[System.Obsolete("This broker implementation is generally available. Use WithBroker(BrokerOptions) in Microsoft.Identity.Client.Broker package instead. See https://aka.ms/msal-net-wam for details.", false)]
public static Microsoft.Identity.Client.PublicClientApplicationBuilder WithBrokerPreview (this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, bool enableBroker = true);

[<System.Obsolete("This broker implementation is generally available. Use WithBroker(BrokerOptions) in Microsoft.Identity.Client.Broker package instead. See https://aka.ms/msal-net-wam for details.", false)>]
static member WithBrokerPreview : Microsoft.Identity.Client.PublicClientApplicationBuilder * bool -> Microsoft.Identity.Client.PublicClientApplicationBuilder

<Extension()>
Public Function WithBrokerPreview (builder As PublicClientApplicationBuilder, Optional enableBroker As Boolean = true) As PublicClientApplicationBuilder

Parameters

builder: PublicClientApplicationBuilder

enableBroker: Boolean

Returns

PublicClientApplicationBuilder

Attributes: ObsoleteAttribute

Remarks

No broker integration exists on Mac and Linux yet. Windows broker does not work on Win 8, Win Server 2016 and lower. This implementation is not supported on UWP, use WithBroker() from Microsoft.Identity.Client package instead. If a broker does not exist or cannot be used, MSAL will fallback to a browser. Make sure browser auth is enabled (e.g. if using system browser, register the "http://localhost" redirect URI, etc.)

Applies to