refresh readme

README.md

@@ -4,86 +4,79 @@
 
 The ADAL for python library makes it easy for python applications to authenticate to AAD in order to access AAD protected web resources.
 
-# Note
-This is an early, pre-release version of the library.  It does not yet have support for any kind of caching.
-
 ## Usage
 
-### Acquire Token with Username & Password
-
-```python
-import adal
-token_response = adal.acquire_token_with_username_password(
-    'https://login.windows.net/ACTIVE_DIRECTORY_TENANT.onmicrosoft.com',
-    'username@ACTIVE_DIRECTORY_TENANT.onmicrosoft.com',
-    'password'
-)
-```
-
 ### Acquire Token with Client Credentials
 
-In order to use this token acquisition method, you need to:
-
-1) Create an Azure Active Directory (AD) instance on your Azure account
-
-2) Create an application in the AD instance and name it PythonSDK http://PythonSDK
-
-3) Go to the configure tab and you can find all of the following information:
-
-- Click on 'View Endpoints' and Copy the 'Federation Metadata Document' entry. The Root + GUID URL is our Authority.
-- Exit out of App Endpoints.  The Client ID is on the configure page.
-- In the keys section of the Azure AD App Configure page, create a key (1 or 2 years is fine)
-
+In order to use this token acquisition method, you need to configure a service principal. Please follow [this walkthrough](https://azure.microsoft.com/en-us/documentation/articles/resource-group-create-service-principal-portal/).
 
+See the [sample](./sample/client_credentials_sample.py).
 ```python
 import adal
-token_response = adal.acquire_token_with_client_credentials(
-    "https://login.microsoftonline.com/ABCDEFGH-1234-1234-1234-ABCDEFGHIJKL", # Authority
-    "ABCDEFGH-1234-1234-1234-ABCDEFGHIJKL", # Client ID
-    "a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a=" # Client Secret
-)
-```
-
-If you are using this with the Azure SDK, you will need to give the PythonSDK application we have access.
-From PowerShell, you can execute the following:
 
-```powershell
-### Install the Azure Resource Manager (ARM) PowerShell module from the PowerShell Gallery
-Install-Module -Name AzureRm
-
-### Install the AzureRm child modules (this may take a few minutes)
-Install-AzureRm
-
-### Authenticate to Microsoft Azure (an authentication dialog will open)
-$null = Login-AzureRmAccount
-
-### List out the Microsoft Azure subscriptions available to your account
-Get-AzureRmSubscription | Format-Table -AutoSize
-
-### Select the Microsoft Azure subscription you want to manipulate
-Set-AzureRmContext -SubscriptionId ABCDEFGH-1234-1234-1234-ABCDEFGH
-
-### List out the Azure Active Directory (AAD) Service Principals in your AAD tenant
-Get-AzureRmADServicePrincipal | Sort-Object -Property DisplayName
+context = adal.AuthenticationContext('https://login.microsoftonline.com/ABCDEFGH-1234-1234-1234-ABCDEFGHIJKL')
+RESOURCE = '00000002-0000-0000-c000-000000000000' #AAD graph resource
+token = context.acquire_token_with_client_credentials(
+    RESOURCE,
+    "http://PythonSDK", 
+    "Key-Configured-In-Portal")
+```
 
-### Assign the "contributor" role to your Azure Active Directory (AAD) Service Principal
-New-AzureRmRoleAssignment -ServicePrincipalName http://PythonSDK -RoleDefinitionName Contributor
+### Acquire Token with client certificate
+A service principal is also required. See the [sample](./sample/certificate_credentials_sample.py).
+```python
+import adal
+context = adal.AuthenticationContext('https://login.microsoftonline.com/ABCDEFGH-1234-1234-1234-ABCDEFGHIJKL')
+RESOURCE = '00000002-0000-0000-c000-000000000000' #AAD graph resource
+token = context.acquire_token_with_client_certificate(
+    RESOURCE,
+    "http://PythonSDK",  
+    'yourPrivateKeyFileContent', 
+    'thumbprintOfPrivateKey')
 ```
 
 ### Acquire Token with Refresh Token
-
+See the [sample](./sample/refresh_token_sample.py).
 ```python
 import adal
-token_response = adal.acquire_token_with_username_password(
-    'https://login.windows.net/ACTIVE_DIRECTORY_TENANT.onmicrosoft.com',
-    'username@ACTIVE_DIRECTORY_TENANT.onmicrosoft.com',
-    'password'
-
-# Use returned refresh token to acquire a new token.
-refresh_token = token_response['refreshToken']
-token_response = adal.acquire_token_with_refresh_token(authority, refresh_token)
+context = adal.AuthenticationContext('https://login.microsoftonline.com/ABCDEFGH-1234-1234-1234-ABCDEFGHIJKL')
+RESOURCE = '00000002-0000-0000-c000-000000000000' #AAD graph resource
+token = context.acquire_token_with_username_password(
+    RESOURCE, 
+    'yourName',
+    'yourPassword',
+    'yourClientIdHere')
+
+refresh_token = token['refreshToken']
+token = context.acquire_token_with_refresh_token(
+    refresh_token,
+    'yourClientIdHere',
+    RESOURCE)
 ```
 
+### Acquire Token with device code
+See the [sample](./sample/device_code_sample.py).
+```python
+context = adal.AuthenticationContext('https://login.microsoftonline.com/ABCDEFGH-1234-1234-1234-ABCDEFGHIJKL')
+RESOURCE = '00000002-0000-0000-c000-000000000000' #AAD graph resource
+code = context.acquire_user_code(RESOURCE, 'yourClientIdHere')
+print(code['message'])
+token = context.acquire_token_with_device_code(RESOURCE, code, 'yourClientIdHere')
+``` 
+
+### Acquire Token with authorization code
+See the [sample](./sample/website_sample.py) for a complete bare bones web site that makes use of the code below.
+```python
+context = adal.AuthenticationContext('https://login.microsoftonline.com/ABCDEFGH-1234-1234-1234-ABCDEFGHIJKL')
+RESOURCE = '00000002-0000-0000-c000-000000000000' #AAD graph resource
+return auth_context.acquire_token_with_authorization_code(
+            'yourCodeFromQueryString', 
+            'yourWebRedirectUri', 
+            RESOURCE, 
+            'yourClientId', 
+            'yourClientSecret')
+``` 
+
 ## Samples and Documentation
 [We provide a full suite of sample applications and documentation on GitHub](https://github.com/AzureADSamples) to help you get started with learning the Azure Identity system. This includes tutorials for native clients such as Windows, Windows Phone, iOS, OSX, Android, and Linux. We also provide full walkthroughs for authentication flows such as OAuth2, OpenID Connect, Graph API, and other awesome features.
 

sample/client_credentials_sample.py

@@ -39,7 +39,7 @@ def turn_on_logging():
 RESOURCE = '00000002-0000-0000-c000-000000000000'
 
 #uncomment for verbose log
-turn_on_logging()
+#turn_on_logging()
 
 context = adal.AuthenticationContext(authority_url)
 

sample/device_code_sample.py

@@ -42,7 +42,7 @@ def turn_on_logging():
 RESOURCE = '00000002-0000-0000-c000-000000000000'
 
 #uncomment for verbose logging 
-turn_on_logging()
+#turn_on_logging()
 
 context = adal.AuthenticationContext(authority_url)
 code = context.acquire_user_code(RESOURCE, clientid)

sample/refresh_token_sample.py

@@ -40,7 +40,7 @@ def turn_on_logging():
 RESOURCE = '00000002-0000-0000-c000-000000000000'
 
 #uncomment for verbose log
-turn_on_logging()
+#turn_on_logging()
 
 context = adal.AuthenticationContext(authority_url)