Skip to content

Commit 479e596

Browse files
xiangyan99chlowellpvaneck
authored
Update doc for the credentials that default to cli app id (#36308)
* Update doc for the credentials that default to cli app id * Update sdk/identity/azure-identity/azure/identity/_credentials/browser.py Co-authored-by: Charles Lowell <[email protected]> * Update sdk/identity/azure-identity/azure/identity/_credentials/device_code.py Co-authored-by: Paul Van Eck <[email protected]> --------- Co-authored-by: Charles Lowell <[email protected]> Co-authored-by: Paul Van Eck <[email protected]>
1 parent 1022b46 commit 479e596

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

sdk/identity/azure-identity/azure/identity/_credentials/browser.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ class InteractiveBrowserCredential(InteractiveCredential):
2727
defines authorities for other clouds.
2828
:keyword str tenant_id: a Microsoft Entra tenant ID. Defaults to the "organizations" tenant, which can
2929
authenticate work or school accounts.
30-
:keyword str client_id: Client ID of the Microsoft Entra application users will sign in to. If
31-
unspecified, users will authenticate to an Azure development application.
30+
:keyword str client_id: Client ID of the Microsoft Entra application that users will sign into. It is recommended
31+
that developers register their applications and assign appropriate roles. For more information,
32+
visit https://aka.ms/identity/AppRegistrationAndRoleAssignment. If not specified, users will authenticate to
33+
an Azure development application, which is not recommended for production scenarios.
3234
:keyword str login_hint: a username suggestion to pre-fill the login page's username/email address field. A user
3335
may still log in with a different username.
3436
:keyword str redirect_uri: a redirect URI for the application identified by `client_id` as configured in Azure

sdk/identity/azure-identity/azure/identity/_credentials/device_code.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ class DeviceCodeCredential(InteractiveCredential):
2323
SSH session. If a web browser is available, :class:`~azure.identity.InteractiveBrowserCredential` is more
2424
convenient because it automatically opens a browser to the login page.
2525
26-
:param str client_id: client ID of the application users will authenticate to. When not specified users will
27-
authenticate to an Azure development application.
26+
:keyword str client_id: Client ID of the Microsoft Entra application that users will sign into. It is recommended
27+
that developers register their applications and assign appropriate roles. For more information,
28+
visit https://aka.ms/identity/AppRegistrationAndRoleAssignment. If not specified, users will authenticate to
29+
an Azure development application, which is not recommended for production scenarios.
2830
2931
:keyword str authority: Authority of a Microsoft Entra endpoint, for example "login.microsoftonline.com",
3032
the authority for Azure Public Cloud (which is the default). :class:`~azure.identity.AzureAuthorityHosts`

0 commit comments

Comments
 (0)