Skip to content

Commit 22ef938

Browse files
committed
Use image map to guide customer to proper sample
1 parent 5b8f12c commit 22ef938

File tree

1 file changed

+53
-6
lines changed

1 file changed

+53
-6
lines changed

docs/index.rst

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,64 @@ MSAL Python documentation
1010
GitHub Repository <https://github.com/AzureAD/microsoft-authentication-library-for-python>
1111

1212
You can find high level conceptual documentations in the project
13-
`README <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_
14-
and
15-
`workable samples inside the project code base
16-
<https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample>`_
17-
.
13+
`README <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_.
14+
15+
Scenarios
16+
=========
17+
18+
There are many `different application scenarios <https://docs.microsoft.com/en-us/azure/active-directory/develop/authentication-flows-app-scenarios>`_.
19+
MSAL Python supports some of them.
20+
**The following diagram serves as a map. Locate your application scenario on the map.**
21+
**If the corresponding icon is clickable, it will bring you to an MSAL Python sample for that scenario.**
22+
23+
* Most authentication scenarios acquire tokens on behalf of signed-in users.
24+
25+
.. raw:: html
26+
27+
<!-- Derived from http://www.image-map.net/ but we had to manually add unique map id -->
28+
<img src="https://docs.microsoft.com/en-us/azure/active-directory/develop/media/scenarios/scenarios-with-users.svg" usemap="#public-map">
29+
<map name="public-map">
30+
<area target="_blank" coords="110,150,59,94" shape="rect"
31+
alt="Web app" title="Web app" href="https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-v2-python-webapp">
32+
<area target="_blank" coords="58,281,108,338" shape="rect"
33+
alt="Web app" title="Web app" href="https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-v2-python-webapp">
34+
<area target="_blank" coords="57,529,127,470" shape="rect"
35+
alt="Desktop App" title="Desktop App" href="https://github.com/AzureAD/microsoft-authentication-library-for-python/blob/dev/sample/interactive_sample.py">
36+
<!-- TODO: Upgrade this sample to use Interactive Flow: https://github.com/Azure-Samples/ms-identity-python-desktop/blob/master/1-Call-MsGraph-WithUsernamePassword/username_password_sample.py -->
37+
<area target="_blank" coords="56,637,122,566" shape="rect"
38+
alt="Browserless app" title="Browserless app" href="https://github.com/Azure-Samples/ms-identity-python-devicecodeflow">
39+
</map>
40+
41+
* There are also daemon apps. In these scenarios, applications acquire tokens on behalf of themselves with no user.
42+
43+
.. raw:: html
44+
45+
<!-- Derived from http://www.image-map.net/ but we had to manually add unique map id -->
46+
<img src="https://docs.microsoft.com/en-us/azure/active-directory/develop/media/scenarios/daemon-app.svg" usemap="#confidential-map">
47+
48+
<map name="confidential-map">
49+
<area target="_blank" coords="48,1,165,260" shape="rect"
50+
alt="Daemon App acquires token for themselves" title="Daemon App acquires token for themselves" href="https://github.com/Azure-Samples/ms-identity-python-daemon">
51+
</map>
52+
53+
* There are other less common samples, such for ADAL-to-MSAL migration,
54+
`available inside the project code base
55+
<https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample>`_.
1856

19-
The documentation hosted here is for API Reference.
2057

2158
API
2259
===
2360

61+
The following section is the API Reference of MSAL Python.
62+
63+
.. note::
64+
65+
Only APIs and their parameters documented in this section are part of public API,
66+
with guaranteed backward compatibility for the entire 1.x series.
67+
68+
Other modules in the source code are all considered as internal helpers,
69+
which could change at anytime in the future, without prior notice.
70+
2471
MSAL proposes a clean separation between
2572
`public client applications and confidential client applications
2673
<https://tools.ietf.org/html/rfc6749#section-2.1>`_.

0 commit comments

Comments
 (0)