Skip to content

Commit ce1e067

Browse files
authored
Addressing PR comments
1 parent 62666e6 commit ce1e067

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
1-
# Microsoft Authentication Library (MSAL) for Python
1+
# Microsoft Authentication Library (MSAL) for Python Preview
22

3-
The MSAL library for Python gives your app the ability to begin using the [Microsoft Cloud](https://cloud.microsoft.com)
4-
by supporting [Microsoft Azure Active Directory](https://azure.microsoft.com/en-us/services/active-directory/)
5-
and [Microsoft Accounts](https://account.microsoft.com) in a converged experience using industry standard OAuth2 and OpenID Connect.
3+
The MSAL library for Python enables your app to access the
4+
[Microsoft Cloud](https://cloud.microsoft.com)
5+
by supporting authentication of users with
6+
[Microsoft Azure Active Directory accounts](https://azure.microsoft.com/en-us/services/active-directory/)
7+
and [Microsoft Accounts](https://account.microsoft.com) using industry standard OAuth2 and OpenID Connect.
68
Soon MSAL Python will also support [Azure AD B2C](https://azure.microsoft.com/services/active-directory-b2c/).
79

810
More and more detail about MSAL Python functionality and usage will be documented in the
911
[Wiki](https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki).
1012

13+
## Important Note about the MSAL Preview
14+
15+
This library is suitable for use in a production environment.
16+
We provide the same production level support for this library as we do our current production libraries.
17+
During the preview we may make changes to the API, internal cache format, and other mechanisms of this library,
18+
which you will be required to take along with bug fixes or feature improvements.
19+
This may impact your application.
20+
For instance, a change to the cache format may impact your users, such as requiring them to sign in again.
21+
An API change may require you to update your code.
22+
When we provide the General Availability release
23+
we will require you to update to the General Availability version within six months,
24+
as applications written using a preview version of library may no longer work.
25+
1126
## Installation
1227

1328
1. If you haven't already, [install and/or upgrade the pip](https://pip.pypa.io/en/stable/installing/)
@@ -19,10 +34,9 @@ More and more detail about MSAL Python functionality and usage will be documente
1934
Before using MSAL Python (or any MSAL SDKs, for that matter), you will have to
2035
[register your application with the AAD 2.0 endpoint](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-v2-register-an-app).
2136

22-
Acquiring tokens with MSAL Python is somewhat different than ADAL Python. You will need to follow this 3-step pattern.
37+
Acquiring tokens with MSAL Python need to follow this 3-step pattern.
2338

24-
1. Contrary to ADAL (which proposes the notion of `AuthenticationContext`, which is a connection to Azure AD),
25-
MSAL proposes a clean separation between
39+
1. MSAL proposes a clean separation between
2640
[public client applications, and confidential client applications](https://tools.ietf.org/html/rfc6749#section-2.1).
2741
So you will first create either a `PublicClientApplication` or a `ConfidentialClientApplication` instance,
2842
and ideally reuse it during the lifecycle of your app. For example:
@@ -34,7 +48,7 @@ Acquiring tokens with MSAL Python is somewhat different than ADAL Python. You wi
3448

3549
Later, each time you would want an access token, you start by:
3650
```python
37-
result = None
51+
result = None # It is just an initial value. Please follow instructions below.
3852
```
3953

4054
2. The API model in MSAL provides you explicit control on how to utilize token cache.
@@ -73,7 +87,6 @@ Acquiring tokens with MSAL Python is somewhat different than ADAL Python. You wi
7387
```
7488

7589
That is it. There will be some variations for different flows.
76-
You can try [runnable samples in this repo](https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample).
7790

7891

7992
## Samples and Documentation
@@ -86,6 +99,9 @@ are recommended reading.
8699

87100
The API reference of MSAL Python is coming soon.
88101

102+
You can try [runnable samples in this repo](https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample).
103+
104+
89105
## Versions
90106

91107
This library follows [Semantic Versioning](http://semver.org/).

0 commit comments

Comments
 (0)