Skip to content

Commit 4e7938e

Browse files
localdenlocalden
authored
Merge pull request #81 from MicrosoftDocs/smoke-test
Smoke test
2 parents a2a8b6d + 03019b6 commit 4e7938e

10 files changed

+150
-57
lines changed

‎.openpublishing.publish.config.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,8 @@
9191
"branch_target_mapping": {},
9292
"skip_source_output_uploading": false,
9393
"contribution_branch_mappings": {},
94-
"need_generate_pdf_url_template": true
94+
"need_generate_pdf_url_template": true,
95+
"redirection_files": [
96+
"redirections/.openpublishing.redirection.simplify-package-structure.json"
97+
]
9598
}

‎python/docs-ref-autogen/msal/index.yml‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

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

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,19 @@ constructor:
1616
token_cache=None, http_client=None, verify=True, proxies=None, timeout=None, client_claims=None,
1717
app_name=None, app_version=None, client_capabilities=None, azure_region=None,
1818
exclude_scopes=None, http_cache=None, instance_discovery=None, allow_broker=None,
19-
enable_pii_log=None)
19+
enable_pii_log=None, oidc_authority=None)
2020
parameters:
2121
- name: client_id
22-
description: Your app has a client_id after you register it on AAD.
22+
description: Your app has a client_id after you register it on Microsoft Entra
23+
admin center.
2324
isRequired: true
2425
types:
2526
- <xref:str>
2627
- name: client_credential
27-
description: "For <xref:msal.application.PublicClientApplication>, you simply\
28-
\ use *None* here.\nFor <xref:msal.application.ConfidentialClientApplication>,\n\
29-
it can be a string containing client secret,\nor an X509 certificate container\
30-
\ in this form:\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
28+
description: "For <xref:msal.application.PublicClientApplication>, you use *None*\
29+
\ here.\nFor <xref:msal.application.ConfidentialClientApplication>,\nit can\
30+
\ be a string containing client secret,\nor an X509 certificate container in\
31+
\ this form:\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
3132
: [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\", \"language\"\
3233
: \"default\", \"force\": false, \"linenos\": false} -->\n\n````default\n\n\
3334
\ {\n \"private_key\": \"...-----BEGIN PRIVATE KEY-----... in PEM format\"\
@@ -298,6 +299,22 @@ constructor:
298299
defaultValue: None
299300
types:
300301
- <xref:boolean>
302+
- name: oidc_authority
303+
description: '*Added in version 1.28.0*:
304+
305+
It is a URL that identifies an OpenID Connect (OIDC) authority of
306+
307+
the format `https://contoso.com/tenant`.
308+
309+
MSAL will append ".well-known/openid-configuration" to the authority
310+
311+
and retrieve the OIDC metadata from there, to figure out the endpoints.
312+
313+
314+
Note: Broker will NOT be used for OIDC authority.'
315+
defaultValue: None
316+
types:
317+
- <xref:str>
301318
methods:
302319
- uid: msal.application.ClientApplication.acquire_token_by_auth_code_flow
303320
name: acquire_token_by_auth_code_flow
@@ -338,7 +355,7 @@ methods:
338355
339356
changes are in the scopes.
340357
341-
In AAD, tokens can be issued for multiple 3rd party resources.
358+
In Microsoft Entra, tokens can be issued for multiple 3rd party resources.
342359
343360
You can ask authorization code for multiple resources,
344361
@@ -396,7 +413,7 @@ methods:
396413
397414
changes are in the scopes.
398415
399-
In AAD, tokens can be issued for multiple 3rd party resources.
416+
In Microsoft Entra, tokens can be issued for multiple 3rd party resources.
400417
401418
You can ask authorization code for multiple resources,
402419
@@ -432,9 +449,9 @@ methods:
432449
- name: redirect_uri
433450
defaultValue: None
434451
return:
435-
description: "A dict representing the json response from AAD:\n\n* A successful\
436-
\ response would contain \"access_token\" key, \n\n* an error response would\
437-
\ contain \"error\" and usually \"error_description\"."
452+
description: "A dict representing the json response from Microsoft Entra:\n\n\
453+
* A successful response would contain \"access_token\" key, \n\n* an error response\
454+
\ would contain \"error\" and usually \"error_description\"."
438455
- uid: msal.application.ClientApplication.acquire_token_by_refresh_token
439456
name: acquire_token_by_refresh_token
440457
summary: 'Acquire token(s) based on a refresh token (RT) obtained from elsewhere.
@@ -522,9 +539,9 @@ methods:
522539
types:
523540
- <xref:object>
524541
return:
525-
description: "A dict representing the json response from AAD:\n\n* A successful\
526-
\ response would contain \"access_token\" key, \n\n* an error response would\
527-
\ contain \"error\" and usually \"error_description\"."
542+
description: "A dict representing the json response from Microsoft Entra:\n\n\
543+
* A successful response would contain \"access_token\" key, \n\n* an error response\
544+
\ would contain \"error\" and usually \"error_description\"."
528545
- uid: msal.application.ClientApplication.acquire_token_silent
529546
name: acquire_token_silent
530547
summary: 'Acquire an access token for given account, without user interaction.

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

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,19 @@ constructor:
1616
validate_authority=True, token_cache=None, http_client=None, verify=True, proxies=None,
1717
timeout=None, client_claims=None, app_name=None, app_version=None, client_capabilities=None,
1818
azure_region=None, exclude_scopes=None, http_cache=None, instance_discovery=None,
19-
allow_broker=None, enable_pii_log=None)
19+
allow_broker=None, enable_pii_log=None, oidc_authority=None)
2020
parameters:
2121
- name: client_id
22-
description: Your app has a client_id after you register it on AAD.
22+
description: Your app has a client_id after you register it on Microsoft Entra
23+
admin center.
2324
isRequired: true
2425
types:
2526
- <xref:str>
2627
- name: client_credential
27-
description: "For <xref:msal.application.PublicClientApplication>, you simply\
28-
\ use *None* here.\nFor <xref:msal.application.ConfidentialClientApplication>,\n\
29-
it can be a string containing client secret,\nor an X509 certificate container\
30-
\ in this form:\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
28+
description: "For <xref:msal.application.PublicClientApplication>, you use *None*\
29+
\ here.\nFor <xref:msal.application.ConfidentialClientApplication>,\nit can\
30+
\ be a string containing client secret,\nor an X509 certificate container in\
31+
\ this form:\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
3132
: [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\", \"language\"\
3233
: \"default\", \"force\": false, \"linenos\": false} -->\n\n````default\n\n\
3334
\ {\n \"private_key\": \"...-----BEGIN PRIVATE KEY-----... in PEM format\"\
@@ -298,6 +299,22 @@ constructor:
298299
defaultValue: None
299300
types:
300301
- <xref:boolean>
302+
- name: oidc_authority
303+
description: '*Added in version 1.28.0*:
304+
305+
It is a URL that identifies an OpenID Connect (OIDC) authority of
306+
307+
the format `https://contoso.com/tenant`.
308+
309+
MSAL will append ".well-known/openid-configuration" to the authority
310+
311+
and retrieve the OIDC metadata from there, to figure out the endpoints.
312+
313+
314+
Note: Broker will NOT be used for OIDC authority.'
315+
defaultValue: None
316+
types:
317+
- <xref:str>
301318
methods:
302319
- uid: msal.application.ConfidentialClientApplication.acquire_token_for_client
303320
name: acquire_token_for_client
@@ -329,9 +346,9 @@ methods:
329346
from these locations.'
330347
defaultValue: None
331348
return:
332-
description: "A dict representing the json response from AAD:\n\n* A successful\
333-
\ response would contain \"access_token\" key, \n\n* an error response would\
334-
\ contain \"error\" and usually \"error_description\"."
349+
description: "A dict representing the json response from Microsoft Entra:\n\n\
350+
* A successful response would contain \"access_token\" key, \n\n* an error response\
351+
\ would contain \"error\" and usually \"error_description\"."
335352
- uid: msal.application.ConfidentialClientApplication.acquire_token_on_behalf_of
336353
name: acquire_token_on_behalf_of
337354
summary: 'Acquires token using on-behalf-of (OBO) flow.
@@ -380,9 +397,9 @@ methods:
380397
from these locations.'
381398
defaultValue: None
382399
return:
383-
description: "A dict representing the json response from AAD:\n\n* A successful\
384-
\ response would contain \"access_token\" key, \n\n* an error response would\
385-
\ contain \"error\" and usually \"error_description\"."
400+
description: "A dict representing the json response from Microsoft Entra:\n\n\
401+
* A successful response would contain \"access_token\" key, \n\n* an error response\
402+
\ would contain \"error\" and usually \"error_description\"."
386403
- uid: msal.application.ConfidentialClientApplication.remove_tokens_for_client
387404
name: remove_tokens_for_client
388405
summary: 'Remove all tokens that were previously acquired via

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ constructor:
5454
types:
5555
- <xref:boolean>
5656
- name: client_id
57+
isRequired: true
5758
- name: client_credential
5859
defaultValue: None
5960
methods:
@@ -86,9 +87,9 @@ methods:
8687
from these locations.'
8788
defaultValue: None
8889
return:
89-
description: "A dict representing the json response from AAD:\n\n* A successful\
90-
\ response would contain \"access_token\" key, \n\n* an error response would\
91-
\ contain \"error\" and usually \"error_description\"."
90+
description: "A dict representing the json response from Microsoft Entra:\n\n\
91+
* A successful response would contain \"access_token\" key, \n\n* an error response\
92+
\ would contain \"error\" and usually \"error_description\"."
9293
- uid: msal.application.PublicClientApplication.acquire_token_interactive
9394
name: acquire_token_interactive
9495
summary: 'Acquire token interactively i.e. via a local browser.
@@ -176,7 +177,8 @@ methods:
176177
types:
177178
- <xref:int>
178179
- name: extra_scopes_to_consent
179-
description: '"Extra scopes to consent" is a concept only available in AAD.
180+
description: '"Extra scopes to consent" is a concept only available in Microsoft
181+
Entra.
180182
181183
It refers to other resources you might want to prompt to consent for,
182184

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ functions:
88
signature: extract_certs(public_cert_content)
99
parameters:
1010
- name: public_cert_content
11+
isRequired: true
1112
classes:
1213
- msal.application.ClientApplication
1314
- msal.application.ConfidentialClientApplication

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ functions:
88
signature: is_subdict_of(small, big)
99
parameters:
1010
- name: small
11+
isRequired: true
1112
- name: big
13+
isRequired: true
1214
classes:
1315
- msal.token_cache.SerializableTokenCache
1416
- msal.token_cache.TokenCache

‎python/docs-ref-autogen/toc.yml‎

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,34 @@
11
- items:
22
- name: Overview
3-
uid: project-msal
3+
uid: msal
44
- items:
55
- name: Overview
66
uid: msal.application
7-
- name: msal.application.ClientApplication
7+
- name: ClientApplication
88
uid: msal.application.ClientApplication
9-
- name: msal.application.ConfidentialClientApplication
9+
- name: ConfidentialClientApplication
1010
uid: msal.application.ConfidentialClientApplication
11-
- name: msal.application.PublicClientApplication
11+
- name: PublicClientApplication
1212
uid: msal.application.PublicClientApplication
13-
name: msal.application
13+
name: application
1414
- items:
1515
- name: Overview
1616
uid: msal.auth_scheme
17-
- name: msal.auth_scheme.PopAuthScheme
17+
- name: PopAuthScheme
1818
uid: msal.auth_scheme.PopAuthScheme
19-
name: msal.auth_scheme
19+
name: auth_scheme
2020
- items:
2121
- name: Overview
2222
uid: msal.token_cache
23-
- name: msal.token_cache.SerializableTokenCache
23+
- name: SerializableTokenCache
2424
uid: msal.token_cache.SerializableTokenCache
2525
- items:
2626
- name: Overview
2727
uid: msal.token_cache.TokenCache
28-
- name: msal.token_cache.TokenCache.AuthorityType
28+
- name: AuthorityType
2929
uid: msal.token_cache.TokenCache.AuthorityType
30-
- name: msal.token_cache.TokenCache.CredentialType
30+
- name: CredentialType
3131
uid: msal.token_cache.TokenCache.CredentialType
32-
name: msal.token_cache.TokenCache
33-
name: msal.token_cache
34-
- name: msal
35-
uid: msal
32+
name: TokenCache
33+
name: token_cache
3634
name: msal
37-

‎redirections/.openpublishing.redirection.simplify-package-structure.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"redirections": [
3+
{
4+
"source_path_from_root": "/python/docs-ref-autogen/msal/index.yml",
5+
"redirect_url": "/python/api/msal/msal",
6+
"redirect_document_id": false
7+
}
8+
]
9+
}

0 commit comments

Comments
 (0)