Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit pass on Azure Identity Broker README #38339

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Edit pass on Azure Identity Broker README #38339

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4de4141
Edit pass on Azure Identity Broker README
scottaddie Nov 5, 2024
e4aba85
Change version
scottaddie Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions sdk/identity/azure-identity-broker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@


# Azure Identity Broker plugin for Python

This package extends the [Azure Identity][azure_identity] library by providing supplemental credentials for authenticating via an authentication broker.
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.

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:
- Web Account Manager (WAM) on Windows
- Company Portal on macOS
| Broker | Minimum package version |
|-------------------------------------------|-------------------------|
| [Company Portal][company_portal] on macOS | 1.3.0b1 |
| Web Account Manager (WAM) on Windows 10+ | 1.0.0 |

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

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

## Key concepts

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

### Parent window handles

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

## Redirect URIs

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:
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.

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

## Examples

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