Xbase++

Outlook Contact OAuth2 Access Token - Using Azure AD v2.0 Endpoint

See more Outlook Contact Examples

Demonstrates how to get a Microsoft Graph OAuth2 access token from a desktop application or script using scopes for Outlook Contact.

Microsoft Graph supports two authentication providers:

• To authenticate users with personal Microsoft accounts, such as live.com or outlook.com accounts, use the Azure Active Directory (Azure AD) v2.0 endpoint.
• To authenticate users with enterprise (that is, work or school) accounts, use Azure AD.

This example uses the Azure Active Directory (Azure AD) v2.0 endpoint.

Xbase++

LOCAL nSuccess
LOCAL oOauth2
LOCAL cUrl
LOCAL nNumMsWaited
LOCAL oJson
LOCAL oFac

nSuccess := 0

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  See more Microsoft Graph OAuth2 examples:
//  
//  Microsoft Graph OAuth2 App Authentication using Azure AD
//  Microsoft Graph OAuth2 Client Credentials Grant Flow
//  Microsoft Graph -- Renew Expiring Access Token (Azure AD v2.0 Endpoint)
//  Microsoft Graph -- Renew Expiring Access Token (Azure AD Endpoint)
//  Decode Microsoft Graph ID Token
//  Microsoft Graph Revoke OAuth2 Access Tokens

oOauth2 := CreateObject("Chilkat.OAuth2")

//  This should be the port in the localhost callback URL for your app.  
//  The callback URL would look like "http://localhost:3017/" if the port number is 3017.
oOauth2:ListenPort := 3017

oOauth2:AuthorizationEndpoint := "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
oOauth2:TokenEndpoint := "https://login.microsoftonline.com/common/oauth2/v2.0/token"

//  Replace these with actual values.
oOauth2:ClientId := "MICROSOFT-GRAPH-CLIENT-ID"
//  This is your app password:
oOauth2:ClientSecret := "MICROSOFT-GRAPH-CLIENT-SECRET"

oOauth2:CodeChallenge := 0
//  Provide a SPACE separated list of scopes.
//  See https://developer.microsoft.com/en-us/graph/docs/authorization/permission_scopes 

//  Important: To get a refresh token in the final response, you have to ask for "offline_access" scope
oOauth2:Scope := "openid profile offline_access user.readwrite contacts.readwrite files.readwrite"

//  Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
cUrl := oOauth2:StartAuth()
IF (oOauth2:LastMethodSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

//  Launch the system's default browser navigated to the URL.
nSuccess := oOauth2:LaunchBrowser(cUrl)
IF (nSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

//  Now wait for the authorization.
//  We'll wait for a max of 30 seconds.
nNumMsWaited := 0
DO WHILE (nNumMsWaited < 30000) .AND. (oOauth2:AuthFlowState < 3)
    oOauth2:SleepMs(100)
    nNumMsWaited := nNumMsWaited + 100
ENDDO

//  If there was no response from the browser within 30 seconds, then 
//  the AuthFlowState will be equal to 1 or 2.
//  1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
//  2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
//  In that case, cancel the background task started in the call to StartAuth.
IF (oOauth2:AuthFlowState < 3)
    oOauth2:Cancel()
    ? "No response from the browser!"
    oOauth2:destroy()
    RETURN
ENDIF

//  Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
//  The possible AuthFlowState values are:
//  3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
//  4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
//  5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
IF (oOauth2:AuthFlowState == 5)
    ? "OAuth2 failed to complete."
    ? oOauth2:FailureInfo
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState == 4)
    ? "OAuth2 authorization was denied."
    ? oOauth2:AccessTokenResponse
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState != 3)
    ? "Unexpected AuthFlowState:" + Str(oOauth2:AuthFlowState)
    oOauth2:destroy()
    RETURN
ENDIF

? "OAuth2 authorization granted!"
? "Access Token = " + oOauth2:AccessToken

//  Get the full JSON response:
oJson := CreateObject("Chilkat.JsonObject")
oJson:Load(oOauth2:AccessTokenResponse)
oJson:EmitCompact := 0

//  The JSON response looks like this:

//  {
//    "token_type": "Bearer",
//    "scope": "openid profile User.ReadWrite Contacts.ReadWrite Files.ReadWrite ...",
//    "expires_in": 3600,
//    "ext_expires_in": 3600,
//    "access_token": "EwBAA8l6B...",
//    "refresh_token": "MCRMdbe...",
//    "id_token": "eyJ0eXA..."
//  }

? oJson:Emit()

//  Save the JSON to a file for future requests.
oFac := CreateObject("Chilkat.FileAccess")
oFac:WriteEntireTextFile("qa_data/tokens/outlookContacts.json", oJson:Emit(), "utf-8", 0)

oOauth2:destroy()
oJson:destroy()
oFac:destroy()