Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ class InteractiveBrowserCredential(InteractiveCredential):
will cache tokens in memory.
:paramtype cache_persistence_options: ~azure.identity.TokenCachePersistenceOptions
:keyword int timeout: seconds to wait for the user to complete authentication. Defaults to 300 (5 minutes).
:keyword bool allow_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 Windows operating system uses
the Web Account Manager (WAM) as its authentication broker. If this parameter is set to True, the broker will
be used when possible. Defaults to False.
Check https://learn.microsoft.com/azure/active-directory/develop/scenario-desktop-acquire-token-wam for more
information about WAM.
:keyword int parent_window_handle: If your app is a GUI app running on a modern Windows system,
and your app opts in to use broker via `allow_broker`, 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 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
to authenticate. Setting this to true will completely disable both instance discovery and authority validation.
This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class DeviceCodeCredential(InteractiveCredential):
authenticate work or school accounts. **Required for single-tenant applications.**
:keyword int timeout: seconds to wait for the user to authenticate. Defaults to the validity period of the
device code as set by Azure Active Directory, which also prevails when **timeout** is longer.

:keyword prompt_callback: A callback enabling control of how authentication
instructions are presented. Must accept arguments (``verification_uri``, ``user_code``, ``expires_on``):

Expand All @@ -41,6 +42,7 @@ class DeviceCodeCredential(InteractiveCredential):
- ``expires_on`` (datetime.datetime) the UTC time at which the code will expire
If this argument isn't provided, the credential will print instructions to stdout.
:paramtype prompt_callback: Callable[str, str, ~datetime.datetime]

:keyword AuthenticationRecord authentication_record: :class:`AuthenticationRecord` returned by :func:`authenticate`
:keyword bool disable_automatic_authentication: if True, :func:`get_token` will raise
:class:`AuthenticationRequiredError` when user interaction is required to acquire a token. Defaults to False.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ class UsernamePasswordCredential(InteractiveCredential):
https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the
authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and
trustworthy.
:keyword bool allow_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 Windows operating system uses
the Web Account Manager (WAM) as its authentication broker. If this parameter is set to True, the broker will
be used when possible. Defaults to False.
Check https://learn.microsoft.com/azure/active-directory/develop/scenario-desktop-acquire-token-wam for more
information about WAM.
:keyword List[str] additionally_allowed_tenants: Specifies tenants in addition to the specified "tenant_id"
for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to
acquire tokens for any tenant the application can access.
Expand Down