Skip to content

Commit 51c59ee

Browse files
authored
Update credential docstrings (Azure#18205)
1 parent 896380d commit 51c59ee

File tree

8 files changed

+17
-6
lines changed

8 files changed

+17
-6
lines changed

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ class InteractiveBrowserCredential(InteractiveCredential):
3030
3131
:func:`~get_token` opens a browser to a login URL provided by Azure Active Directory and authenticates a user
3232
there with the authorization code flow, using PKCE (Proof Key for Code Exchange) internally to protect the code.
33-
Azure Active Directory documentation describes the authentication flow in more detail:
34-
https://docs.microsoft.com/azure/active-directory/develop/v1-protocols-oauth-code
3533
3634
:keyword str authority: Authority of an Azure Active Directory endpoint, for example 'login.microsoftonline.com',
3735
the authority for Azure Public Cloud (which is the default). :class:`~azure.identity.AzureAuthorityHosts`

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ class CertificateCredential(ClientCredentialBase):
2323
2424
The certificate must have an RSA private key, because this credential signs assertions using RS256.
2525
26+
See Azure Active Directory documentation for more information on configuring certificate authentication:
27+
https://docs.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-microsoft-identity-platform
28+
2629
:param str tenant_id: ID of the service principal's tenant. Also called its 'directory' ID.
2730
:param str client_id: the service principal's client ID
2831
:param str certificate_path: path to a PEM-encoded certificate file including the private key. If not provided,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313

1414
class ClientSecretCredential(ClientCredentialBase):
15-
"""Authenticates as a service principal using a client ID and client secret.
15+
"""Authenticates as a service principal using a client secret.
1616
1717
:param str tenant_id: ID of the service principal's tenant. Also called its 'directory' ID.
1818
:param str client_id: the service principal's client ID

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ class DeviceCodeCredential(InteractiveCredential):
2727
A user must browse to the URL, enter the code, and authenticate with Azure Active Directory. If the user
2828
authenticates successfully, the credential receives an access token.
2929
30-
For more information about the device code flow, see Azure Active Directory documentation:
31-
https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-device-code
30+
This credential is primarily useful for authenticating a user in an environment without a web browser, such as an
31+
SSH session. If a web browser is available, :class:`~azure.identity.InteractiveBrowserCredential` is more
32+
convenient because it automatically opens a browser to the login page.
3233
3334
:param str client_id: client ID of the application users will authenticate to. When not specified users will
3435
authenticate to an Azure development application.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ class ManagedIdentityCredential(object):
2828
This credential defaults to using a system-assigned identity. To configure a user-assigned identity, use one of
2929
the keyword arguments.
3030
31+
See Azure Active Directory documentation for more information about configuring managed identity for applications:
32+
https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview
33+
3134
:keyword str client_id: a user-assigned identity's client ID. This is supported in all hosting environments.
3235
:keyword identity_config: a mapping ``{parameter_name: value}`` specifying a user-assigned identity by its object
3336
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to

sdk/identity/azure-identity/azure/identity/aio/_credentials/certificate.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ class CertificateCredential(AsyncContextManager, GetTokenMixin):
2222
2323
The certificate must have an RSA private key, because this credential signs assertions using RS256.
2424
25+
See Azure Active Directory documentation for more information on configuring certificate authentication:
26+
https://docs.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-microsoft-identity-platform
27+
2528
:param str tenant_id: ID of the service principal's tenant. Also called its 'directory' ID.
2629
:param str client_id: the service principal's client ID
2730
:param str certificate_path: path to a PEM-encoded certificate file including the private key. If not provided,

sdk/identity/azure-identity/azure/identity/aio/_credentials/client_secret.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818

1919
class ClientSecretCredential(AsyncContextManager, GetTokenMixin):
20-
"""Authenticates as a service principal using a client ID and client secret.
20+
"""Authenticates as a service principal using a client secret.
2121
2222
:param str tenant_id: ID of the service principal's tenant. Also called its 'directory' ID.
2323
:param str client_id: the service principal's client ID

sdk/identity/azure-identity/azure/identity/aio/_credentials/managed_identity.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ class ManagedIdentityCredential(AsyncContextManager):
2626
This credential defaults to using a system-assigned identity. To configure a user-assigned identity, use one of
2727
the keyword arguments.
2828
29+
See Azure Active Directory documentation for more information about configuring managed identity for applications:
30+
https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview
31+
2932
:keyword str client_id: a user-assigned identity's client ID. This is supported in all hosting environments.
3033
:keyword identity_config: a mapping ``{parameter_name: value}`` specifying a user-assigned identity by its object
3134
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to

0 commit comments

Comments
 (0)