@@ -1948,8 +1948,6 @@ def __init__(
1948
1948
1949
1949
.. note::
1950
1950
1951
- You may set enable_broker_on_windows and/or enable_broker_on_mac and/or enable_broker_on_linux and/or enable_broker_on_wsl to True.
1952
-
1953
1951
**What is a broker, and why use it?**
1954
1952
1955
1953
A broker is a component installed on your device.
@@ -1967,22 +1965,26 @@ def __init__(
1967
1965
so that your broker-enabled apps (even a CLI)
1968
1966
could automatically SSO from a previously established signed-in session.
1969
1967
1970
- **You shall only enable broker when your app: **
1968
+ **How to opt in to use broker? **
1971
1969
1972
- 1. is running on supported platforms,
1973
- and already registered their corresponding redirect_uri
1970
+ 1. You can set any combination of the following opt-in parameters to true:
1974
1971
1975
- * ``ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id``
1976
- if your app is expected to run on Windows 10+
1977
- * ``msauth.com.msauth.unsignedapp://auth``
1978
- if your app is expected to run on Mac
1979
- * ``ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id``
1980
- if your app is expected to run on Linux, especially WSL
1972
+ +--------------------------+-----------------------------------+------------------------------------------------------------------------------------+
1973
+ | Opt-in flag | If app will run on | App has registered this as a Desktop platform redirect URI in Azure Portal |
1974
+ +==========================+===================================+====================================================================================+
1975
+ | enable_broker_on_windows | Windows 10+ | ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id |
1976
+ +--------------------------+-----------------------------------+------------------------------------------------------------------------------------+
1977
+ | enable_broker_on_wsl | WSL | ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id |
1978
+ +--------------------------+-----------------------------------+------------------------------------------------------------------------------------+
1979
+ | enable_broker_on_mac | Mac with Company Portal installed | msauth.com.msauth.unsignedapp://auth |
1980
+ +--------------------------+-----------------------------------+------------------------------------------------------------------------------------+
1981
+ | enable_broker_on_linux | Linux with Intune installed | ``https://login.microsoftonline.com/common/oauth2/nativeclient`` (MUST be enabled) |
1982
+ +--------------------------+-----------------------------------+------------------------------------------------------------------------------------+
1981
1983
1982
- 2. installed broker dependency,
1984
+ 2. Install broker dependency,
1983
1985
e.g. ``pip install msal[broker]>=1.33,<2``.
1984
1986
1985
- 3. tested with ``acquire_token_interactive()`` and ``acquire_token_silent()``.
1987
+ 3. Test with ``acquire_token_interactive()`` and ``acquire_token_silent()``.
1986
1988
1987
1989
**The fallback behaviors of MSAL Python's broker support**
1988
1990
0 commit comments