1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
.. ADAL Python documentation master file, created by
sphinx-quickstart on Wed Apr 25 15:50:25 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. This file is also inspired by
https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example
.. note::
This library, ADAL for Python, will no longer receive new feature improvement. Its successor,
`MSAL for Python <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_,
are now generally available.
* If you are starting a new project, you can get started with the
`MSAL Python docs <https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki>`_
for details about the scenarios, usage, and relevant concepts.
* If your application is using the previous ADAL Python library, you can follow this
`migration guide <https://docs.microsoft.com/en-us/azure/active-directory/develop/migrate-python-adal-msal>`_
to update to MSAL Python.
* Existing applications relying on ADAL Python will continue to work.
Welcome to ADAL Python's documentation!
=======================================
.. toctree::
:maxdepth: 2
:caption: Contents:
You can find high level conceptual documentations in the project
`wiki <https://github.com/AzureAD/azure-activedirectory-library-for-python/wiki>`_
and
`workable samples inside the project code base
<https://github.com/AzureAD/azure-activedirectory-library-for-python/tree/dev/sample>`_
The documentation hosted here is for API Reference.
AuthenticationContext
=====================
The majority of ADAL Python functionalities are provided via the main class
named `AuthenticationContext`.
.. autoclass:: adal.AuthenticationContext
:members:
.. automethod:: __init__
TokenCache
==========
One of the parameter accepted by `AuthenticationContext` is the `TokenCache`.
.. autoclass:: adal.TokenCache
:members:
:undoc-members:
If you need to subclass it, you need to refer to its source code for the detail.
AdalError
=========
When errors are detected by ADAL Python, it will raise this exception.
.. autoclass:: adal.AdalError
:members:
|
