(Excel) Dynamics CRM OAuth2 Access Token

Demonstrates how to get a Microsoft Dynamics CRM OAuth2 access token from a desktop (installed) application or script.

Download Excel Class Modules

Chilkat Excel Class Modules

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

Dim oauth2 As Chilkat.OAuth2
Set oauth2 = Chilkat.NewOAuth2

' This should be the port in the localhost redirect URL for your app.
' Important: Make sure the redirect URI in your Azure app registration 
' is exactly "http://localhost:3017/".  Don't forget the ending "/" char.
' The redirect URL would look like "http://localhost:3017/" if the port number is 3017.
oauth2.ListenPort = 3017

' Get the endpoints from the Azure Portal in the "endpoints" section of App Registrations..
' The DYNAMICS-ENDPOINT-GUID is a Tenant dynamics-endpoint-guid  such as 1b54e7ee-d61b-4f12-a621-a6b2805b98c2
oauth2.AuthorizationEndpoint = "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize"
oauth2.TokenEndpoint = "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token"

' Replace these with actual values.
oauth2.ClientId = "DYNAMICS-CRM-CLIENT-ID"
oauth2.ClientSecret = "DYNAMICS-CRM-SECRET-KEY"

oauth2.Resource = "https://mydynamicsdomain.api.crm.dynamics.com"

oauth2.RedirectAllowHtml = "<html><body><p>Thank you for granting access.</p></bod></html>"
oauth2.RedirectDenyHtml = "<html><body><p>Maybe next time...</p></bod></html>"

' Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.

url = oauth2.StartAuth()
If (oauth2.LastMethodSuccess <> True) Then
    Debug.Print oauth2.LastErrorText
    Exit Sub
End If

' We can pre-check the URL by sending a GET to catch any up-front errors.
' If we receive JSON with an error in response, then we don't proceed any farther.

' If we receive an HTML response, and the response status = 200, then all should be OK.
' We can proceed by displaying an interactive browser loaded with the url.
Dim http As Chilkat.Http
Set http = Chilkat.NewHttp
Dim sbPreCheck As Chilkat.StringBuilder
Set sbPreCheck = Chilkat.NewStringBuilder
success = http.QuickGetSb(url,sbPreCheck)
If ((http.LastStatus <> 200) Or (sbPreCheck.StartsWith("{",True) <> True)) Then
    Debug.Print "JSON Error Response:"
    Debug.Print sbPreCheck.GetAsString()
    Exit Sub
End If

' If the HTTP request itself failed, then examine the error.
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' OK.. the pre-flight check seems OK, go ahead with getting the interactive user authorization..

' At this point, your application should load the URL in a browser.
' For example, 
' in C#:  System.Diagnostics.Process.Start(url);
' in Java: Desktop.getDesktop().browse(new URI(url));
' in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
'              wsh.Run url
' in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
' in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
' The GitHub account owner would interactively accept or deny the authorization request.

' Add the code to load the url in a web browser here...
' Add the code to load the url in a web browser here...
' Add the code to load the url in a web browser here...

' Now wait for the authorization.
' We'll wait for a max of 30 seconds.

numMsWaited = 0
Do While (numMsWaited < 30000) And (oauth2.AuthFlowState < 3)
    oauth2.SleepMs 100
    numMsWaited = numMsWaited + 100
Loop

' 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 (oauth2.AuthFlowState < 3) Then
    success = oauth2.Cancel()
    Debug.Print "No response from the browser!"
    Exit Sub
End If

' 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 (oauth2.AuthFlowState = 5) Then
    Debug.Print "OAuth2 failed to complete."
    Debug.Print oauth2.FailureInfo
    Exit Sub
End If

If (oauth2.AuthFlowState = 4) Then
    Debug.Print "OAuth2 authorization was denied."
    Debug.Print oauth2.AccessTokenResponse
    Exit Sub
End If

If (oauth2.AuthFlowState <> 3) Then
    Debug.Print "Unexpected AuthFlowState:"; oauth2.AuthFlowState
    Exit Sub
End If

Debug.Print "OAuth2 authorization granted!"
Debug.Print "Access Token = "; oauth2.AccessToken

' Get the full JSON response:
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.Load(oauth2.AccessTokenResponse)
json.EmitCompact = False

' The JSON response looks like this:

' {
'   "token_type": "Bearer",
'   "scope": "user_impersonation",
'   "expires_in": "3599",
'   "ext_expires_in": "0",
'   "expires_on": "1524783438",
'   "not_before": "1524779538",
'   "resource": "https://mydomain.api.crm.dynamics.com",
'   "access_token": "...",
'   "refresh_token": "...",
'   "id_token": "..."
' }

' If an "expires_on" member does not exist, then add the JSON member by
' getting the current system date/time and adding the "expires_in" seconds.
' This way we'll know when the token expires.
If (json.HasMember("expires_on") <> True) Then
    Dim dtExpire As Chilkat.CkDateTime
    Set dtExpire = Chilkat.NewCkDateTime
    success = dtExpire.SetFromCurrentSystemTime()
    success = dtExpire.AddSeconds(json.IntOf("expires_in"))
    success = json.AppendString("expires_on",dtExpire.GetAsUnixTimeStr(False))
End If

Debug.Print json.Emit()

' Save the JSON to a file for future requests.
Dim fac As Chilkat.FileAccess
Set fac = Chilkat.NewFileAccess
success = fac.WriteEntireTextFile("qa_data/tokens/dynamicsCrm.json",json.Emit(),"utf-8",False)