diff --git a/python/docs-ref-autogen/msal/msal.application.ClientApplication.yml b/python/docs-ref-autogen/msal/msal.application.ClientApplication.yml index fe570d4..daad16d 100644 --- a/python/docs-ref-autogen/msal/msal.application.ClientApplication.yml +++ b/python/docs-ref-autogen/msal/msal.application.ClientApplication.yml @@ -5,7 +5,12 @@ fullName: msal.application.ClientApplication module: msal.application inheritances: - builtins.object -summary: Create an instance of application. +summary: 'You do not usually directly use this class. Use its subclasses instead: + + and . + + + Create an instance of application.' constructor: syntax: ClientApplication(client_id, client_credential=None, authority=None, validate_authority=True, token_cache=None, http_client=None, verify=True, proxies=None, timeout=None, client_claims=None, @@ -284,8 +289,9 @@ constructor: types: - - name: allow_broker - description: "A broker is a component installed on your device.\nBroker implicitly\ - \ gives your device an identity. By using a broker,\nyour device becomes a factor\ + description: "This parameter is NOT applicable to .\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\ @@ -533,12 +539,9 @@ methods: summary: 'Acquire an access token for given account, without user interaction. - It is done either by finding a valid access token from cache, - - or by finding a valid refresh token from cache and then automatically - - use it to redeem a new access token. + It has same parameters as the . + The difference is the behavior of the return value. This method will combine the cache empty and refresh error @@ -546,25 +549,10 @@ methods: If your app does not care about the exact token refresh error during - token cache look-up, then this method is easier and recommended. - - - Internally, this method calls .' + token cache look-up, then this method is easier and recommended.' signature: acquire_token_silent(scopes, account, authority=None, force_refresh=False, claims_challenge=None, **kwargs) parameters: - - name: claims_challenge - description: 'The claims_challenge parameter requests specific claims requested - by the resource provider - - in the form of a claims_challenge directive in the www-authenticate header to - be - - returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. - - It is a string of a JSON object which contains lists of claims being requested - from these locations.' - defaultValue: None - name: scopes isRequired: true - name: account @@ -573,6 +561,8 @@ methods: defaultValue: None - name: force_refresh defaultValue: 'False' + - name: claims_challenge + defaultValue: None return: description: "* A dict containing no \"error\" key, and typically contains an\ \ \"access_token\" key, if cache lookup succeeded. \n\n* None when cache lookup\ @@ -608,9 +598,13 @@ methods: types: - [] - name: account - description: 'one of the account object returned by , + description: '(Required) + + One of the account object returned by . - or use None when you want to find an access token for this client.' + Starting from MSAL Python 1.23, + + a `None` input will become a NO-OP and always return `None`.' isRequired: true - name: force_refresh description: 'If True, it will skip Access Token look-up, @@ -723,12 +717,12 @@ methods: through on the sign-in page, leading to a slightly more streamlined user experience. - More information on possible values + More information on possible values available in - [here](/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) + [Auth Code Flow doc](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) and - [here](/openspecs/windows_protocols/ms-oapx/86fb452d-e34a-494e-ac61-e526e263b6d8).' + [domain_hint doc](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-oapx/86fb452d-e34a-494e-ac61-e526e263b6d8).' defaultValue: None - name: claims_challenge description: 'The claims_challenge parameter requests specific claims requested @@ -801,12 +795,12 @@ methods: through on the sign-in page, leading to a slightly more streamlined user experience. - More information on possible values + More information on possible values available in - [here](/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) + [Auth Code Flow doc](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) and - [here](/openspecs/windows_protocols/ms-oapx/86fb452d-e34a-494e-ac61-e526e263b6d8).' + [domain_hint doc](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-oapx/86fb452d-e34a-494e-ac61-e526e263b6d8).' defaultValue: None - name: max_age description: 'OPTIONAL. Maximum Authentication Age. diff --git a/python/docs-ref-autogen/msal/msal.application.ConfidentialClientApplication.yml b/python/docs-ref-autogen/msal/msal.application.ConfidentialClientApplication.yml index 740c292..67f26af 100644 --- a/python/docs-ref-autogen/msal/msal.application.ConfidentialClientApplication.yml +++ b/python/docs-ref-autogen/msal/msal.application.ConfidentialClientApplication.yml @@ -5,7 +5,12 @@ fullName: msal.application.ConfidentialClientApplication module: msal.application inheritances: - msal.application.ClientApplication -summary: Create an instance of application. +summary: 'Same as , + + except that `allow_broker` parameter shall remain `None`. + + + Create an instance of application.' constructor: syntax: ConfidentialClientApplication(client_id, client_credential=None, authority=None, validate_authority=True, token_cache=None, http_client=None, verify=True, proxies=None, @@ -285,8 +290,9 @@ constructor: types: - - name: allow_broker - description: "A broker is a component installed on your device.\nBroker implicitly\ - \ gives your device an identity. By using a broker,\nyour device becomes a factor\ + description: "This parameter is NOT applicable to .\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\ @@ -315,7 +321,12 @@ constructor: methods: - uid: msal.application.ConfidentialClientApplication.acquire_token_for_client name: acquire_token_for_client - summary: Acquires token for the current confidential client, not for an end user. + summary: 'Acquires token for the current confidential client, not for an end user. + + + Since MSAL Python 1.23, it will automatically look for token from cache, + + and only send request to Identity Provider when cache misses.' signature: acquire_token_for_client(scopes, claims_challenge=None, **kwargs) parameters: - name: scopes diff --git a/python/docs-ref-autogen/msal/msal.application.PublicClientApplication.yml b/python/docs-ref-autogen/msal/msal.application.PublicClientApplication.yml index 28da7c2..152cd33 100644 --- a/python/docs-ref-autogen/msal/msal.application.PublicClientApplication.yml +++ b/python/docs-ref-autogen/msal/msal.application.PublicClientApplication.yml @@ -5,6 +5,9 @@ fullName: msal.application.PublicClientApplication module: msal.application inheritances: - msal.application.ClientApplication +summary: 'Same as , + + except that `client_credential` parameter shall remain `None`.' constructor: syntax: PublicClientApplication(client_id, client_credential=None, **kwargs) parameters: @@ -92,12 +95,12 @@ methods: through on the sign-in page, leading to a slightly more streamlined user experience. - More information on possible values + More information on possible values available in - [here](/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) + [Auth Code Flow doc](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) and - [here](/openspecs/windows_protocols/ms-oapx/86fb452d-e34a-494e-ac61-e526e263b6d8).' + [domain_hint doc](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-oapx/86fb452d-e34a-494e-ac61-e526e263b6d8).' defaultValue: None - name: claims_challenge description: 'The claims_challenge parameter requests specific claims requested diff --git a/python/docs-ref-autogen/msal/msal.token_cache.TokenCache.yml b/python/docs-ref-autogen/msal/msal.token_cache.TokenCache.yml index 652bd1a..8f906db 100644 --- a/python/docs-ref-autogen/msal/msal.token_cache.TokenCache.yml +++ b/python/docs-ref-autogen/msal/msal.token_cache.TokenCache.yml @@ -19,7 +19,7 @@ methods: - uid: msal.token_cache.TokenCache.add name: add summary: Handle a token obtaining event, and add tokens into cache. - signature: add() + signature: add(event, now=None) parameters: - name: event isRequired: true diff --git a/xrefmap.yml b/xrefmap.yml index 09aa8ba..dd402ca 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -1447,6 +1447,38 @@ references: href: https://docs.python.org/3/library/stdtypes.html#class.__mro__ name: __mro__ uid: class.__mro__ +- fullName: clinic.CConverter.c_default + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.c_default + name: c_default + uid: clinic.CConverter.c_default +- fullName: clinic.CConverter.c_ignored_default + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.c_ignored_default + name: c_ignored_default + uid: clinic.CConverter.c_ignored_default +- fullName: clinic.CConverter.converter + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.converter + name: converter + uid: clinic.CConverter.converter +- fullName: clinic.CConverter.default + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.default + name: default + uid: clinic.CConverter.default +- fullName: clinic.CConverter.impl_by_reference + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.impl_by_reference + name: impl_by_reference + uid: clinic.CConverter.impl_by_reference +- fullName: clinic.CConverter.parse_by_reference + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.parse_by_reference + name: parse_by_reference + uid: clinic.CConverter.parse_by_reference +- fullName: clinic.CConverter.py_default + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.py_default + name: py_default + uid: clinic.CConverter.py_default +- fullName: clinic.CConverter.type + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter.type + name: type + uid: clinic.CConverter.type - fullName: cmd.Cmd.cmdqueue href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.cmdqueue name: cmdqueue @@ -18323,34 +18355,6 @@ references: href: https://docs.python.org/3/library/constants.html#False name: 'False' uid: 'False' -- fullName: METH_CLASS - href: https://docs.python.org/3/c-api/structures.html#METH_CLASS - name: METH_CLASS - uid: METH_CLASS -- fullName: METH_COEXIST - href: https://docs.python.org/3/c-api/structures.html#METH_COEXIST - name: METH_COEXIST - uid: METH_COEXIST -- fullName: METH_FASTCALL - href: https://docs.python.org/3/c-api/structures.html#METH_FASTCALL - name: METH_FASTCALL - uid: METH_FASTCALL -- fullName: METH_NOARGS - href: https://docs.python.org/3/c-api/structures.html#METH_NOARGS - name: METH_NOARGS - uid: METH_NOARGS -- fullName: METH_O - href: https://docs.python.org/3/c-api/structures.html#METH_O - name: METH_O - uid: METH_O -- fullName: METH_STATIC - href: https://docs.python.org/3/c-api/structures.html#METH_STATIC - name: METH_STATIC - uid: METH_STATIC -- fullName: METH_VARARGS - href: https://docs.python.org/3/c-api/structures.html#METH_VARARGS - name: METH_VARARGS - uid: METH_VARARGS - fullName: None href: https://docs.python.org/3/library/constants.html#None name: None @@ -18359,90 +18363,6 @@ references: href: https://docs.python.org/3/library/constants.html#NotImplemented name: NotImplemented uid: NotImplemented -- fullName: Py_TPFLAGS_BASETYPE - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_BASETYPE - name: Py_TPFLAGS_BASETYPE - uid: Py_TPFLAGS_BASETYPE -- fullName: Py_TPFLAGS_BASE_EXC_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_BASE_EXC_SUBCLASS - name: Py_TPFLAGS_BASE_EXC_SUBCLASS - uid: Py_TPFLAGS_BASE_EXC_SUBCLASS -- fullName: Py_TPFLAGS_BYTES_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_BYTES_SUBCLASS - name: Py_TPFLAGS_BYTES_SUBCLASS - uid: Py_TPFLAGS_BYTES_SUBCLASS -- fullName: Py_TPFLAGS_DEFAULT - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_DEFAULT - name: Py_TPFLAGS_DEFAULT - uid: Py_TPFLAGS_DEFAULT -- fullName: Py_TPFLAGS_DICT_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_DICT_SUBCLASS - name: Py_TPFLAGS_DICT_SUBCLASS - uid: Py_TPFLAGS_DICT_SUBCLASS -- fullName: Py_TPFLAGS_DISALLOW_INSTANTIATION - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_DISALLOW_INSTANTIATION - name: Py_TPFLAGS_DISALLOW_INSTANTIATION - uid: Py_TPFLAGS_DISALLOW_INSTANTIATION -- fullName: Py_TPFLAGS_HAVE_FINALIZE - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_HAVE_FINALIZE - name: Py_TPFLAGS_HAVE_FINALIZE - uid: Py_TPFLAGS_HAVE_FINALIZE -- fullName: Py_TPFLAGS_HAVE_GC - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_HAVE_GC - name: Py_TPFLAGS_HAVE_GC - uid: Py_TPFLAGS_HAVE_GC -- fullName: Py_TPFLAGS_HAVE_VECTORCALL - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_HAVE_VECTORCALL - name: Py_TPFLAGS_HAVE_VECTORCALL - uid: Py_TPFLAGS_HAVE_VECTORCALL -- fullName: Py_TPFLAGS_HEAPTYPE - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_HEAPTYPE - name: Py_TPFLAGS_HEAPTYPE - uid: Py_TPFLAGS_HEAPTYPE -- fullName: Py_TPFLAGS_IMMUTABLETYPE - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_IMMUTABLETYPE - name: Py_TPFLAGS_IMMUTABLETYPE - uid: Py_TPFLAGS_IMMUTABLETYPE -- fullName: Py_TPFLAGS_LIST_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_LIST_SUBCLASS - name: Py_TPFLAGS_LIST_SUBCLASS - uid: Py_TPFLAGS_LIST_SUBCLASS -- fullName: Py_TPFLAGS_LONG_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_LONG_SUBCLASS - name: Py_TPFLAGS_LONG_SUBCLASS - uid: Py_TPFLAGS_LONG_SUBCLASS -- fullName: Py_TPFLAGS_MAPPING - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_MAPPING - name: Py_TPFLAGS_MAPPING - uid: Py_TPFLAGS_MAPPING -- fullName: Py_TPFLAGS_METHOD_DESCRIPTOR - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_METHOD_DESCRIPTOR - name: Py_TPFLAGS_METHOD_DESCRIPTOR - uid: Py_TPFLAGS_METHOD_DESCRIPTOR -- fullName: Py_TPFLAGS_READY - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_READY - name: Py_TPFLAGS_READY - uid: Py_TPFLAGS_READY -- fullName: Py_TPFLAGS_READYING - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_READYING - name: Py_TPFLAGS_READYING - uid: Py_TPFLAGS_READYING -- fullName: Py_TPFLAGS_SEQUENCE - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_SEQUENCE - name: Py_TPFLAGS_SEQUENCE - uid: Py_TPFLAGS_SEQUENCE -- fullName: Py_TPFLAGS_TUPLE_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_TUPLE_SUBCLASS - name: Py_TPFLAGS_TUPLE_SUBCLASS - uid: Py_TPFLAGS_TUPLE_SUBCLASS -- fullName: Py_TPFLAGS_TYPE_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_TYPE_SUBCLASS - name: Py_TPFLAGS_TYPE_SUBCLASS - uid: Py_TPFLAGS_TYPE_SUBCLASS -- fullName: Py_TPFLAGS_UNICODE_SUBCLASS - href: https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_UNICODE_SUBCLASS - name: Py_TPFLAGS_UNICODE_SUBCLASS - uid: Py_TPFLAGS_UNICODE_SUBCLASS - fullName: 'True' href: https://docs.python.org/3/library/constants.html#True name: 'True' @@ -18979,6 +18899,10 @@ references: href: https://docs.python.org/3/library/curses.html#curses.COLOR_YELLOW name: COLOR_YELLOW uid: curses.COLOR_YELLOW +- fullName: curses.COLS + href: https://docs.python.org/3/library/curses.html#curses.COLS + name: COLS + uid: curses.COLS - fullName: curses.ERR href: https://docs.python.org/3/library/curses.html#curses.ERR name: ERR @@ -19359,6 +19283,10 @@ references: href: https://docs.python.org/3/library/curses.html#curses.KEY_UP name: KEY_UP uid: curses.KEY_UP +- fullName: curses.LINES + href: https://docs.python.org/3/library/curses.html#curses.LINES + name: LINES + uid: curses.LINES - fullName: curses.OK href: https://docs.python.org/3/library/curses.html#curses.OK name: OK @@ -21535,6 +21463,14 @@ references: href: https://docs.python.org/3/library/re.html#re.S name: S uid: re.S +- fullName: re.U + href: https://docs.python.org/3/library/re.html#re.U + name: U + uid: re.U +- fullName: re.UNICODE + href: https://docs.python.org/3/library/re.html#re.UNICODE + name: UNICODE + uid: re.UNICODE - fullName: re.VERBOSE href: https://docs.python.org/3/library/re.html#re.VERBOSE name: VERBOSE @@ -24255,6 +24191,10 @@ references: href: https://docs.python.org/3/library/chunk.html#module-chunk name: chunk uid: chunk +- fullName: clinic + href: https://docs.python.org/3/howto/clinic.html#module-clinic + name: clinic + uid: clinic - fullName: cmath href: https://docs.python.org/3/library/cmath.html#module-cmath name: cmath @@ -35203,6 +35143,10 @@ references: href: https://docs.python.org/3/library/chunk.html#chunk.Chunk name: Chunk uid: chunk.Chunk +- fullName: clinic.CConverter + href: https://docs.python.org/3/howto/clinic.html#clinic.CConverter + name: CConverter + uid: clinic.CConverter - fullName: cmd.Cmd href: https://docs.python.org/3/library/cmd.html#cmd.Cmd name: Cmd