Skip to content
Merged
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 @@ -231,14 +231,15 @@ constructor:
- name: azure_region
description: "(optional)\nInstructs MSAL to use the Entra regional token service.\
\ This legacy feature is only available to\nfirst-party applications. Only `acquire_token_for_client()`\
\ is supported.\n\nSupports 3 values:\n\n `azure_region=None` - meaning no\
\ region is used. This is the default value.\n `azure_region=\"some_region\"\
` - meaning the specified region is used.\n `azure_region=True` - meaning\
\ MSAL will try to auto-detect the region. This is not recommended.\n\n\n> [!NOTE]\n\
> Region auto-discovery has been tested on VMs and on Azure Functions. It is\
\ unreliable.\n>\n> Applications using this option should configure a short\
\ timeout.\n>\n> \n>\n> For more details and for the values of the region string\n\
>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
\ is supported.\n\nSupports 4 values:\n\n1. `azure_region=None` - This default\
\ value means no region is configured. MSAL will use the region defined in env\
\ var `MSAL_FORCE_REGION`. \n\n2. `azure_region=\"some_region\"` - meaning the\
\ specified region is used. \n\n3. `azure_region=True` - meaning MSAL will try\
\ to auto-detect the region. This is not recommended. \n\n4. `azure_region=False`\
\ - meaning MSAL will use no region. \n\n\n> [!NOTE]\n> Region auto-discovery\
\ has been tested on VMs and on Azure Functions. It is unreliable.\n>\n> Applications\
\ using this option should configure a short timeout.\n>\n> \n>\n> For more\
\ details and for the values of the region string\n>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
>\n\nNew in version 1.12.0."
defaultValue: None
types:
Expand Down Expand Up @@ -958,6 +959,9 @@ attributes:
- uid: msal.application.ClientApplication.ATTEMPT_REGION_DISCOVERY
name: ATTEMPT_REGION_DISCOVERY
signature: ATTEMPT_REGION_DISCOVERY = True
- uid: msal.application.ClientApplication.DISABLE_MSAL_FORCE_REGION
name: DISABLE_MSAL_FORCE_REGION
signature: DISABLE_MSAL_FORCE_REGION = False
- uid: msal.application.ClientApplication.GET_ACCOUNTS_ID
name: GET_ACCOUNTS_ID
signature: GET_ACCOUNTS_ID = '902'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,14 +231,15 @@ constructor:
- name: azure_region
description: "(optional)\nInstructs MSAL to use the Entra regional token service.\
\ This legacy feature is only available to\nfirst-party applications. Only `acquire_token_for_client()`\
\ is supported.\n\nSupports 3 values:\n\n `azure_region=None` - meaning no\
\ region is used. This is the default value.\n `azure_region=\"some_region\"\
` - meaning the specified region is used.\n `azure_region=True` - meaning\
\ MSAL will try to auto-detect the region. This is not recommended.\n\n\n> [!NOTE]\n\
> Region auto-discovery has been tested on VMs and on Azure Functions. It is\
\ unreliable.\n>\n> Applications using this option should configure a short\
\ timeout.\n>\n> \n>\n> For more details and for the values of the region string\n\
>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
\ is supported.\n\nSupports 4 values:\n\n1. `azure_region=None` - This default\
\ value means no region is configured. MSAL will use the region defined in env\
\ var `MSAL_FORCE_REGION`. \n\n2. `azure_region=\"some_region\"` - meaning the\
\ specified region is used. \n\n3. `azure_region=True` - meaning MSAL will try\
\ to auto-detect the region. This is not recommended. \n\n4. `azure_region=False`\
\ - meaning MSAL will use no region. \n\n\n> [!NOTE]\n> Region auto-discovery\
\ has been tested on VMs and on Azure Functions. It is unreliable.\n>\n> Applications\
\ using this option should configure a short timeout.\n>\n> \n>\n> For more\
\ details and for the values of the region string\n>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
>\n\nNew in version 1.12.0."
defaultValue: None
types:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ summary: "Same as <xref:ClientApplication.__init__>,\nexcept that `client_creden
\ when broker is opted in, installed, initialized,\n>\n> but subsequent token request(s)\
\ failed.\n>"
constructor:
syntax: PublicClientApplication(client_id, client_credential=None, **kwargs)
syntax: PublicClientApplication(client_id, client_credential=None, *, enable_broker_on_windows=None,
enable_broker_on_mac=None, **kwargs)
parameters:
- name: enable_broker_on_windows
description: 'This setting is only effective if your app is running on Windows
Expand All @@ -67,6 +68,11 @@ constructor:
isRequired: true
- name: client_credential
defaultValue: None
keywordOnlyParameters:
- name: enable_broker_on_windows
defaultValue: None
- name: enable_broker_on_mac
defaultValue: None
methods:
- uid: msal.application.PublicClientApplication.acquire_token_by_device_flow
name: acquire_token_by_device_flow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ summary: "This API encapsulates multiple managed identity back-ends:\nVM, App Se
Recipe 2: Write once, run everywhere.\nIf you use different managed identity on\
\ different deployment,\nyou may use an environment variable (such as MY_MANAGED_IDENTITY_CONFIG)\n\
to store a json blob like\n`{\"ManagedIdentityIdType\": \"ClientId\", \"Id\": \"\
foo\"}` or\n`{\"ManagedIdentityIdType\": \"SystemAssignedManagedIdentity\", \"Id\"\
: null})`.\nThe following app can load managed identity configuration dynamically:\n\
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"language\": \"default\",\
\ \"force\": false, \"linenos\": false} -->\n\n````default\n\n import json, os,\
\ msal, requests\n config = os.getenv(\"MY_MANAGED_IDENTITY_CONFIG\")\n assert\
\ config, \"An ENV VAR with value should exist\"\n client = msal.ManagedIdentityClient(\n\
\ json.loads(config),\n http_client=requests.Session(),\n )\n\
\ token = client.acquire_token_for_client(\"resource\")\n ````"
foo\"}` or\n`{\"ManagedIdentityIdType\": \"SystemAssigned\", \"Id\": null}`.\nThe\
\ following app can load managed identity configuration dynamically:\n\n<!-- literal_block\
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
\ [], \"xml:space\": \"preserve\", \"language\": \"default\", \"force\": false,\
\ \"linenos\": false} -->\n\n````default\n\n import json, os, msal, requests\n\
\ config = os.getenv(\"MY_MANAGED_IDENTITY_CONFIG\")\n assert config, \"An ENV\
\ VAR with value should exist\"\n client = msal.ManagedIdentityClient(\n \
\ json.loads(config),\n http_client=requests.Session(),\n )\n token\
\ = client.acquire_token_for_client(\"resource\")\n ````"
constructor:
syntax: 'ManagedIdentityClient(managed_identity: dict | ManagedIdentity | SystemAssignedManagedIdentity
| UserAssignedManagedIdentity, *, http_client, token_cache=None, http_cache=None)'
Expand Down Expand Up @@ -71,9 +71,9 @@ constructor:
- name: http_client
isRequired: true
- name: token_cache
isRequired: true
defaultValue: None
- name: http_cache
isRequired: true
defaultValue: None
methods:
- uid: msal.managed_identity.ManagedIdentityClient.acquire_token_for_client
name: acquire_token_for_client
Expand Down Expand Up @@ -115,4 +115,4 @@ methods:
- name: resource
isRequired: true
- name: claims_challenge
isRequired: true
defaultValue: None
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ constructor:
syntax: UserAssignedManagedIdentity(*, client_id=None, resource_id=None, object_id=None)
keywordOnlyParameters:
- name: client_id
isRequired: true
defaultValue: None
- name: resource_id
isRequired: true
defaultValue: None
- name: object_id
isRequired: true
defaultValue: None
5 changes: 5 additions & 0 deletions python/docs-ref-autogen/msal/msal.sku.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### YamlMime:PythonModule
uid: msal.sku
name: sku
fullName: msal.sku
summary: This module is from where we recieve the client sku name and version.
10 changes: 8 additions & 2 deletions python/docs-ref-autogen/msal/msal.token_cache.TokenCache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,17 @@ methods:
- uid: msal.token_cache.TokenCache.find
name: find
summary: Equivalent to list(search(...)).
signature: find(credential_type, target=None, query=None)
signature: find(credential_type, target=None, query=None, *, now=None)
parameters:
- name: credential_type
isRequired: true
- name: target
defaultValue: None
- name: query
defaultValue: None
keywordOnlyParameters:
- name: now
defaultValue: None
- uid: msal.token_cache.TokenCache.modify
name: modify
signature: modify(credential_type, old_entry, new_key_value_pairs=None)
Expand Down Expand Up @@ -76,14 +79,17 @@ methods:
It is O(1) for AT hits, and O(n) for other types.

Note that it holds a lock during the entire search.'
signature: search(credential_type, target=None, query=None)
signature: search(credential_type, target=None, query=None, *, now=None)
parameters:
- name: credential_type
isRequired: true
- name: target
defaultValue: None
- name: query
defaultValue: None
keywordOnlyParameters:
- name: now
defaultValue: None
- uid: msal.token_cache.TokenCache.update_rt
name: update_rt
signature: update_rt(rt_item, new_rt)
Expand Down
1 change: 1 addition & 0 deletions python/docs-ref-autogen/msal/msal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ modules:
- msal.application
- msal.auth_scheme
- msal.managed_identity
- msal.sku
- msal.token_cache
2 changes: 2 additions & 0 deletions python/docs-ref-autogen/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
- name: UserAssignedManagedIdentity
uid: msal.managed_identity.UserAssignedManagedIdentity
name: managed_identity
- name: sku
uid: msal.sku
- items:
- name: Overview
uid: msal.token_cache
Expand Down
36 changes: 32 additions & 4 deletions xrefmap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -779,6 +779,10 @@ references:
href: https://docs.python.org/3/library/pickle.html#pickle.UnpicklingError
name: UnpicklingError
uid: pickle.UnpicklingError
- fullName: plistlib.InvalidFileException
href: https://docs.python.org/3/library/plistlib.html#plistlib.InvalidFileException
name: InvalidFileException
uid: plistlib.InvalidFileException
- fullName: poplib.error_proto
href: https://docs.python.org/3/library/poplib.html#poplib.error_proto
name: error_proto
Expand Down Expand Up @@ -4051,6 +4055,10 @@ references:
href: https://docs.python.org/3/library/pickle.html#pickle.Pickler.fast
name: fast
uid: pickle.Pickler.fast
- fullName: plistlib.UID.data
href: https://docs.python.org/3/library/plistlib.html#plistlib.UID.data
name: data
uid: plistlib.UID.data
- fullName: property.__name__
href: https://docs.python.org/3/library/functions.html#property.__name__
name: __name__
Expand Down Expand Up @@ -12647,6 +12655,10 @@ references:
href: https://docs.python.org/3/library/mailbox.html#mailbox.MHMessage.set_sequences
name: set_sequences
uid: mailbox.MHMessage.set_sequences
- fullName: mailbox.MMDF.get_bytes
href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDF.get_bytes
name: get_bytes
uid: mailbox.MMDF.get_bytes
- fullName: mailbox.MMDF.get_file
href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDF.get_file
name: get_file
Expand Down Expand Up @@ -12911,10 +12923,18 @@ references:
href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.set_subdir
name: set_subdir
uid: mailbox.MaildirMessage.set_subdir
- fullName: mailbox.mbox.get_bytes
href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.get_bytes
name: get_bytes
uid: mailbox.mbox.get_bytes
- fullName: mailbox.mbox.get_file
href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.get_file
name: get_file
uid: mailbox.mbox.get_file
- fullName: mailbox.mbox.get_string
href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.get_string
name: get_string
uid: mailbox.mbox.get_string
- fullName: mailbox.mbox.lock
href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.lock
name: lock
Expand Down Expand Up @@ -19751,6 +19771,10 @@ references:
href: https://docs.python.org/3/library/dis.html#dis.Instruction.baseopname
name: baseopname
uid: dis.Instruction.baseopname
- fullName: dis.Instruction.cache_info
href: https://docs.python.org/3/library/dis.html#dis.Instruction.cache_info
name: cache_info
uid: dis.Instruction.cache_info
- fullName: dis.Instruction.cache_offset
href: https://docs.python.org/3/library/dis.html#dis.Instruction.cache_offset
name: cache_offset
Expand Down Expand Up @@ -24475,10 +24499,6 @@ references:
href: https://docs.python.org/3/library/token.html#token.NOTEQUAL
name: NOTEQUAL
uid: token.NOTEQUAL
- fullName: token.NT_OFFSET
href: https://docs.python.org/3/library/token.html#token.NT_OFFSET
name: NT_OFFSET
uid: token.NT_OFFSET
- fullName: token.NUMBER
href: https://docs.python.org/3/library/token.html#token.NUMBER
name: NUMBER
Expand Down Expand Up @@ -24995,6 +25015,10 @@ references:
href: https://docs.python.org/3/library/winsound.html#winsound.SND_ALIAS
name: SND_ALIAS
uid: winsound.SND_ALIAS
- fullName: winsound.SND_APPLICATION
href: https://docs.python.org/3/library/winsound.html#winsound.SND_APPLICATION
name: SND_APPLICATION
uid: winsound.SND_APPLICATION
- fullName: winsound.SND_ASYNC
href: https://docs.python.org/3/library/winsound.html#winsound.SND_ASYNC
name: SND_ASYNC
Expand Down Expand Up @@ -27791,6 +27815,10 @@ references:
href: https://docs.python.org/3/library/dataclasses.html#dataclasses.Field
name: Field
uid: dataclasses.Field
- fullName: dataclasses.InitVar
href: https://docs.python.org/3/library/dataclasses.html#dataclasses.InitVar
name: InitVar
uid: dataclasses.InitVar
- fullName: datetime.date
href: https://docs.python.org/3/library/datetime.html#datetime.date
name: date
Expand Down