Update content

python/docs-ref-autogen/msal/msal.application.ClientApplication.yml

@@ -96,11 +96,11 @@ constructor:
     defaultValue: 'True'
     types:
     - <xref:bool>
-  - name: cache
+  - name: token_cache
     description: 'Sets the token cache used by this ClientApplication instance.
 
       By default, an in-memory cache will be created and used.'
-    isRequired: true
+    defaultValue: None
     types:
     - <xref:msal.token_cache.TokenCache>
   - name: http_client
@@ -294,29 +294,7 @@ constructor:
     types:
     - <xref:boolean>
   - name: allow_broker
-    description: "This parameter is NOT applicable to <xref:msal.application.ConfidentialClientApplication>.\n\
-      \nA broker is a component installed on your device.\nBroker implicitly gives\
-      \ your device an identity. By using a broker,\nyour device becomes a factor\
-      \ that can satisfy MFA (Multi-factor authentication).\nThis factor would become\
-      \ mandatory\nif a tenant's admin enables a corresponding Conditional Access\
-      \ (CA) policy.\nThe broker's presence allows Microsoft identity platform\nto\
-      \ have higher confidence that the tokens are being issued to your device,\n\
-      and that is more secure.\n\nAn additional benefit of broker is,\nit runs as\
-      \ a long-lived process with your device's OS,\nand maintains its own cache,\n\
-      so that your broker-enabled apps (even a CLI)\ncould automatically SSO from\
-      \ a previously established signed-in session.\n\nThis parameter defaults to\
-      \ None, which means MSAL will not utilize a broker.\nIf this parameter is set\
-      \ to True,\nMSAL will use the broker whenever possible,\nand automatically fall\
-      \ back to non-broker behavior.\nThat also means your app does not need to enable\
-      \ broker conditionally,\nyou can always set allow_broker to True,\nas long as\
-      \ your app meets the following prerequisite:\n\n* Installed optional dependency,\
-      \ e.g. `pip install msal[broker]>=1.20,<2`. (Note that broker is currently only\
-      \ available on Windows 10+) \n\n* Register a new redirect_uri for your desktop\
-      \ app as: `ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id` \n\n* Tested\
-      \ your app in following scenarios: \n\n  * Windows 10+ \n\n  * PublicClientApplication's\
-      \ following methods:: acquire_token_interactive(), acquire_token_by_username_password(),\
-      \ acquire_token_silent() (or acquire_token_silent_with_error()). \n\n  * AAD\
-      \ and MSA accounts (i.e. Non-ADFS, non-B2C) \n\nNew in version 1.20.0."
+    description: Deprecated. Please use `enable_broker_on_windows` instead.
     defaultValue: None
     types:
     - <xref:boolean>
@@ -332,8 +310,6 @@ constructor:
     defaultValue: None
     types:
     - <xref:boolean>
-  - name: token_cache
-    defaultValue: None
 methods:
 - uid: msal.application.ClientApplication.acquire_token_by_auth_code_flow
   name: acquire_token_by_auth_code_flow

python/docs-ref-autogen/msal/msal.application.ConfidentialClientApplication.yml

@@ -96,11 +96,11 @@ constructor:
     defaultValue: 'True'
     types:
     - <xref:bool>
-  - name: cache
+  - name: token_cache
     description: 'Sets the token cache used by this ClientApplication instance.
 
       By default, an in-memory cache will be created and used.'
-    isRequired: true
+    defaultValue: None
     types:
     - <xref:msal.token_cache.TokenCache>
   - name: http_client
@@ -294,29 +294,7 @@ constructor:
     types:
     - <xref:boolean>
   - name: allow_broker
-    description: "This parameter is NOT applicable to <xref:msal.application.ConfidentialClientApplication>.\n\
-      \nA broker is a component installed on your device.\nBroker implicitly gives\
-      \ your device an identity. By using a broker,\nyour device becomes a factor\
-      \ that can satisfy MFA (Multi-factor authentication).\nThis factor would become\
-      \ mandatory\nif a tenant's admin enables a corresponding Conditional Access\
-      \ (CA) policy.\nThe broker's presence allows Microsoft identity platform\nto\
-      \ have higher confidence that the tokens are being issued to your device,\n\
-      and that is more secure.\n\nAn additional benefit of broker is,\nit runs as\
-      \ a long-lived process with your device's OS,\nand maintains its own cache,\n\
-      so that your broker-enabled apps (even a CLI)\ncould automatically SSO from\
-      \ a previously established signed-in session.\n\nThis parameter defaults to\
-      \ None, which means MSAL will not utilize a broker.\nIf this parameter is set\
-      \ to True,\nMSAL will use the broker whenever possible,\nand automatically fall\
-      \ back to non-broker behavior.\nThat also means your app does not need to enable\
-      \ broker conditionally,\nyou can always set allow_broker to True,\nas long as\
-      \ your app meets the following prerequisite:\n\n* Installed optional dependency,\
-      \ e.g. `pip install msal[broker]>=1.20,<2`. (Note that broker is currently only\
-      \ available on Windows 10+) \n\n* Register a new redirect_uri for your desktop\
-      \ app as: `ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id` \n\n* Tested\
-      \ your app in following scenarios: \n\n  * Windows 10+ \n\n  * PublicClientApplication's\
-      \ following methods:: acquire_token_interactive(), acquire_token_by_username_password(),\
-      \ acquire_token_silent() (or acquire_token_silent_with_error()). \n\n  * AAD\
-      \ and MSA accounts (i.e. Non-ADFS, non-B2C) \n\nNew in version 1.20.0."
+    description: Deprecated. Please use `enable_broker_on_windows` instead.
     defaultValue: None
     types:
     - <xref:boolean>
@@ -332,8 +310,6 @@ constructor:
     defaultValue: None
     types:
     - <xref:boolean>
-  - name: token_cache
-    defaultValue: None
 methods:
 - uid: msal.application.ConfidentialClientApplication.acquire_token_for_client
   name: acquire_token_for_client

python/docs-ref-autogen/msal/msal.application.PublicClientApplication.yml

@@ -5,12 +5,37 @@ fullName: msal.application.PublicClientApplication
 module: msal.application
 inheritances:
 - msal.application.ClientApplication
-summary: 'Same as <xref:ClientApplication.__init__>,
-
-  except that `client_credential` parameter shall remain `None`.'
+summary: "Same as <xref:ClientApplication.__init__>,\nexcept that `client_credential`\
+  \ parameter shall remain `None`.\n\n> [!NOTE]\n> You may set enable_broker_on_windows\
+  \ to True.\n>\n> \n>\n> What is a broker, and why use it?\n>\n> \n>\n> A broker\
+  \ is a component installed on your device.\n>\n> Broker implicitly gives your device\
+  \ an identity. By using a broker,\n>\n> your device becomes a factor that can satisfy\
+  \ MFA (Multi-factor authentication).\n>\n> This factor would become mandatory\n\
+  >\n> if a tenant's admin enables a corresponding Conditional Access (CA) policy.\n\
+  >\n> The broker's presence allows Microsoft identity platform\n>\n> to have higher\
+  \ confidence that the tokens are being issued to your device,\n>\n> and that is\
+  \ more secure.\n>\n> \n>\n> An additional benefit of broker is,\n>\n> it runs as\
+  \ a long-lived process with your device's OS,\n>\n> and maintains its own cache,\n\
+  >\n> so that your broker-enabled apps (even a CLI)\n>\n> could automatically SSO\
+  \ from a previously established signed-in session.\n>\n> \n>\n> ADFS and B2C do\
+  \ not support broker.\n>\n> MSAL will automatically fallback to use browser.\n>\n\
+  > \n>\n> You shall only enable broker when your app:\n>\n> \n>\n> is running on\
+  \ supported platforms,\n>\n> and already registered their corresponding redirect_uri\n\
+  >\n> \n>\n> ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id\n>\n> if your\
+  \ app is expected to run on Windows 10+\n>\n> \n>\n> installed broker dependency,\n\
+  >\n> e.g. pip install msal[broker]>=1.25,<2.\n>\n> \n>\n> tested with acquire_token_interactive()\
+  \ and acquire_token_silent().\n>"
 constructor:
   syntax: PublicClientApplication(client_id, client_credential=None, **kwargs)
   parameters:
+  - name: enable_broker_on_windows
+    description: 'This setting is only effective if your app is running on Windows
+      10+.
+
+      This parameter defaults to None, which means MSAL will not utilize a broker.'
+    isRequired: true
+    types:
+    - <xref:boolean>
   - name: client_id
   - name: client_credential
     defaultValue: None