|
3 | 3 | You can adapt this file completely to your liking, but it should at least |
4 | 4 | contain the root `toctree` directive. |
5 | 5 |
|
| 6 | +.. This file is also inspired by |
| 7 | + https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example |
| 8 | +
|
6 | 9 | Welcome to MSAL Python's documentation! |
7 | 10 | ======================================= |
8 | 11 |
|
9 | 12 | .. toctree:: |
10 | 13 | :maxdepth: 2 |
11 | 14 | :caption: Contents: |
12 | 15 |
|
| 16 | +You can find high level conceptual documentations in the project |
| 17 | +`README <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_ |
| 18 | +and |
| 19 | +`workable samples inside the project code base |
| 20 | +<https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample>`_ |
| 21 | +. |
| 22 | + |
| 23 | +The documentation hosted here is for API Reference. |
| 24 | + |
| 25 | + |
| 26 | +PublicClientApplication and ConfidentialClientApplication |
| 27 | +========================================================= |
| 28 | + |
| 29 | +MSAL proposes a clean separation between |
| 30 | +`public client applications and confidential client applications |
| 31 | +<https://tools.ietf.org/html/rfc6749#section-2.1>`_. |
| 32 | + |
| 33 | +They are implemented as two separated classes, |
| 34 | +with different methods for different authentication scenarios. |
| 35 | + |
| 36 | +PublicClientApplication |
| 37 | +----------------------- |
| 38 | +.. autoclass:: msal.PublicClientApplication |
| 39 | + :members: |
| 40 | + |
| 41 | +ConfidentialClientApplication |
| 42 | +----------------------------- |
| 43 | +.. autoclass:: msal.ConfidentialClientApplication |
| 44 | + :members: |
| 45 | + |
| 46 | + |
| 47 | +Shared Methods |
| 48 | +-------------- |
| 49 | +Both PublicClientApplication and ConfidentialClientApplication |
| 50 | +have following methods inherited from their base class. |
| 51 | +You typically do not need to initiate this base class, though. |
| 52 | + |
| 53 | +.. autoclass:: msal.ClientApplication |
| 54 | + :members: |
| 55 | + |
| 56 | + .. automethod:: __init__ |
| 57 | + |
| 58 | + |
| 59 | +TokenCache |
| 60 | +========== |
| 61 | + |
| 62 | +One of the parameter accepted by |
| 63 | +both `PublicClientApplication` and `ConfidentialClientApplication` |
| 64 | +is the `TokenCache`. |
| 65 | + |
| 66 | +.. autoclass:: msal.TokenCache |
| 67 | + :members: |
| 68 | + |
| 69 | +You can subclass it to add new behavior, such as, token serialization. |
| 70 | +See `SerializableTokenCache` for example. |
| 71 | + |
| 72 | +.. autoclass:: msal.SerializableTokenCache |
| 73 | + :members: |
13 | 74 |
|
14 | 75 |
|
15 | 76 | Indices and tables |
16 | 77 | ================== |
17 | 78 |
|
18 | 79 | * :ref:`genindex` |
19 | | -* :ref:`modindex` |
20 | 80 | * :ref:`search` |
| 81 | + |
0 commit comments