Skip to content

Commit e19cb4d

Browse files
1 parent cedd06c commit e19cb4d

File tree

3 files changed

+24
-7
lines changed

3 files changed

+24
-7
lines changed

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,17 @@ constructor:
5656
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\"\
5757
, \"language\": \"default\", \"force\": false, \"linenos\": false} -->\n\n````default\n\
5858
\n {\n \"client_assertion\": \"...a JWT with claims aud, exp, iss, jti,\
59-
\ nbf, and sub...\"\n }\n ````"
59+
\ nbf, and sub...\"\n }\n ````\n\n\n\n## Supporting reading client cerficates\
60+
\ from PFX files*Added in version 1.29.0*:\nFeed in a dictionary containing\
61+
\ the path to a PFX file:\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
62+
\ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\"\
63+
, \"language\": \"default\", \"force\": false, \"linenos\": false} -->\n\n````default\n\
64+
\n {\n \"private_key_pfx_path\": \"/path/to/your.pfx\",\n \"passphrase\"\
65+
: \"Passphrase if the private_key is encrypted (Optional. Added in version 1.6.0)\"\
66+
,\n }\n ````"
6067
defaultValue: None
6168
types:
62-
- <xref:typing.Union>[<xref:str>, <xref:dict>]
69+
- <xref:typing.Union>[<xref:dict>, <xref:str>]
6370
- name: client_claims
6471
description: "*Added in version 0.5.0*:\nIt is a dictionary of extra claims that\
6572
\ would be signed by\nby this <xref:msal.application.ConfidentialClientApplication>\

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,17 @@ constructor:
5656
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\"\
5757
, \"language\": \"default\", \"force\": false, \"linenos\": false} -->\n\n````default\n\
5858
\n {\n \"client_assertion\": \"...a JWT with claims aud, exp, iss, jti,\
59-
\ nbf, and sub...\"\n }\n ````"
59+
\ nbf, and sub...\"\n }\n ````\n\n\n\n## Supporting reading client cerficates\
60+
\ from PFX files*Added in version 1.29.0*:\nFeed in a dictionary containing\
61+
\ the path to a PFX file:\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
62+
\ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\"\
63+
, \"language\": \"default\", \"force\": false, \"linenos\": false} -->\n\n````default\n\
64+
\n {\n \"private_key_pfx_path\": \"/path/to/your.pfx\",\n \"passphrase\"\
65+
: \"Passphrase if the private_key is encrypted (Optional. Added in version 1.6.0)\"\
66+
,\n }\n ````"
6067
defaultValue: None
6168
types:
62-
- <xref:typing.Union>[<xref:str>, <xref:dict>]
69+
- <xref:typing.Union>[<xref:dict>, <xref:str>]
6370
- name: client_claims
6471
description: "*Added in version 0.5.0*:\nIt is a dictionary of extra claims that\
6572
\ would be signed by\nby this <xref:msal.application.ConfidentialClientApplication>\

python/docs-ref-autogen/msal/msal.token_cache.SerializableTokenCache.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,12 @@ summary: "This serialization can be a starting point to implement your own persi
1111
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
1212
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"language\": \"default\",\
1313
\ \"force\": false, \"linenos\": false} -->\n\n````default\n\n import os, atexit,\
14-
\ msal\n cache = msal.SerializableTokenCache()\n if os.path.exists(\"my_cache.bin\"\
15-
):\n cache.deserialize(open(\"my_cache.bin\", \"r\").read())\n atexit.register(lambda:\n\
16-
\ open(\"my_cache.bin\", \"w\").write(cache.serialize())\n # Hint: The\
14+
\ msal\n cache_filename = os.path.join( # Persist cache into this file\n \
15+
\ os.getenv(\"XDG_RUNTIME_DIR\", \"\"), # Automatically wipe out the cache from\
16+
\ Linux when user's ssh session ends. See also https://github.com/AzureAD/microsoft-authentication-library-for-python/issues/690\n\
17+
\ \"my_cache.bin\")\n cache = msal.SerializableTokenCache()\n if os.path.exists(cache_filename):\n\
18+
\ cache.deserialize(open(cache_filename, \"r\").read())\n atexit.register(lambda:\n\
19+
\ open(cache_filename, \"w\").write(cache.serialize())\n # Hint: The\
1720
\ following optional line persists only when state changed\n if cache.has_state_changed\
1821
\ else None\n )\n app = msal.ClientApplication(..., token_cache=cache)\n\
1922
\ ...\n ````"

0 commit comments

Comments
 (0)