From 6680ffcfc876e26c8e56bc44bd9f58822440ce9d Mon Sep 17 00:00:00 2001 From: Paul Van Eck Date: Tue, 2 Apr 2024 17:21:12 -0700 Subject: [PATCH] [Identity] Update broker docs (#35032) Using a more preferred term. Signed-off-by: Paul Van Eck --- sdk/identity/azure-identity-broker/README.md | 2 +- .../azure-identity-broker/azure/identity/broker/_browser.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/sdk/identity/azure-identity-broker/README.md b/sdk/identity/azure-identity-broker/README.md index 328baf31ec65..308effac0f7c 100644 --- a/sdk/identity/azure-identity-broker/README.md +++ b/sdk/identity/azure-identity-broker/README.md @@ -56,7 +56,7 @@ credential = InteractiveBrowserBrokerCredential(parent_window_handle=current_win client = BlobServiceClient(account_url, credential=credential) ``` -To bypass the account selection dialog and use the account currently signed into the operating system, set the `use_default_broker_account` argument to `True`. The credential will attempt to silently use the default broker account. If using the default account fails, the credential will fall back to interactive authentication. +To bypass the account selection dialog and use the default broker account, set the `use_default_broker_account` argument to `True`. The credential will attempt to silently use the default broker account. If using the default account fails, the credential will fall back to interactive authentication. ```python credential = InteractiveBrowserBrokerCredential( diff --git a/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py b/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py index ae0ed66b1d67..a9a0c0085cdb 100644 --- a/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py +++ b/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py @@ -37,8 +37,8 @@ class InteractiveBrowserBrokerCredential(_InteractiveBrowserCredential): :keyword int timeout: seconds to wait for the user to complete authentication. Defaults to 300 (5 minutes). :keyword int parent_window_handle: If your app is a GUI app running on a modern Windows system, you are required to also provide its window handle so that the sign in UI window will properly pop up on top of your window. - :keyword bool use_default_broker_account: Whether to authenticate with the currently signed in user instead of - prompting the user with a login dialog. Defaults to False. + :keyword bool use_default_broker_account: Enables automatically using the default broker account for + authentication instead of prompting the user with an account picker. Defaults to False. :keyword bool enable_msa_passthrough: Determines whether Microsoft Account (MSA) passthrough is enabled. Note, this is only needed for select legacy first-party applications. Defaults to False. :keyword bool disable_instance_discovery: Determines whether or not instance discovery is performed when attempting