Skip to content

Commit 8e408ae

Browse files
scottaddiel0lawrence
authored andcommitted
Edit pass on Azure Identity Broker README (Azure#38339)
* Edit pass on Azure Identity Broker README * Change version
1 parent c608d85 commit 8e408ae

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

sdk/identity/azure-identity-broker/README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
2-
31
# Azure Identity Broker plugin for Python
42

5-
This package extends the [Azure Identity][azure_identity] library by providing supplemental credentials for authenticating via an authentication broker.
3+
This package extends the [Azure Identity][azure_identity] library by providing supplemental credentials for authenticating via an authentication broker. An authentication broker is an application that runs on a user's machine that manages the authentication handshakes and token maintenance for connected accounts. The table below outlines supported brokers and the minimum package version required to use each of them.
64

7-
An authentication broker is an application that runs on a user’s machine that manages the authentication handshakes and token maintenance for connected accounts. Currently, only the following brokers are supported:
8-
- Web Account Manager (WAM) on Windows
9-
- Company Portal on macOS
5+
| Broker | Minimum package version |
6+
|-------------------------------------------|-------------------------|
7+
| [Company Portal][company_portal] on macOS | 1.3.0b1 |
8+
| Web Account Manager (WAM) on Windows 10+ | 1.0.0 |
109

1110
[Source code][source_code] | [Package (PyPI)][azure_identity_broker] | [API reference documentation][ref_docs] | [Microsoft Entra ID documentation][entra_id]
1211

@@ -22,7 +21,7 @@ pip install azure-identity-broker
2221

2322
## Key concepts
2423

25-
This package enables broker support via `InteractiveBrowserBrokerCredential` which is a subclass of the `InteractiveBrowserCredential` of the Azure Identity library.
24+
This package enables broker support via `InteractiveBrowserBrokerCredential`, which is a subclass of the Azure Identity library's [InteractiveBrowserCredential][ibc].
2625

2726
### Parent window handles
2827

@@ -34,12 +33,12 @@ Microsoft accounts (MSA) are personal accounts created by users to access Micros
3433

3534
## Redirect URIs
3635

37-
Microsoft Entra applications rely on redirect URIs to determine where to send the authentication response after a user has logged in. To enable brokered authentication through broker, a redirect URI matching the following pattern should be registered to the application:
36+
Microsoft Entra applications rely on redirect URIs to determine where to send the authentication response after a user has logged in. To enable brokered authentication, [add a redirect URI](https://learn.microsoft.com/entra/identity-platform/quickstart-register-app#add-a-redirect-uri) to the application for the platform on which it's expected to run.
3837

39-
* ``ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id``
40-
if your app is expected to run on Windows 10+
41-
* ``msauth.com.msauth.unsignedapp://auth``
42-
if your app is expected to run on Mac
38+
| Platform | Redirect URI |
39+
|-------------|-----------------------------------------------------------------------------------------------------------------------|
40+
| macOS | `msauth.com.msauth.unsignedapp://auth` for unsigned applications<br>`msauth.BUNDLE_ID://auth` for signed applications |
41+
| Windows 10+ | `ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id` |
4342

4443
## Examples
4544

@@ -101,7 +100,9 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
101100
[azure_identity_broker]: https://pypi.org/project/azure-identity-broker
102101
[azure_storage_blob]: https://pypi.org/project/azure-storage-blob
103102
[b2c]: https://learn.microsoft.com/azure/active-directory-b2c/overview
103+
[company_portal]: https://learn.microsoft.com/mem/intune/apps/apps-company-portal-macos
104104
[entra_id]: https://learn.microsoft.com/entra/identity/
105+
[ibc]: https://learn.microsoft.com/python/api/azure-identity/azure.identity.interactivebrowsercredential?view=azure-python
105106
[pip]: https://pypi.org/project/pip
106107
[ref_docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-identity-broker/latest/index.html
107108
[source_code]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity-broker

0 commit comments

Comments
 (0)