(Lianja) Dynamics CRM OAuth2 Access Token

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

Chilkat Lianja Extension Download

Chilkat Lianja Extension

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

loOauth2 = createobject("CkOAuth2")

// 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.
loOauth2.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
loOauth2.AuthorizationEndpoint = "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize"
loOauth2.TokenEndpoint = "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token"

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

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

loOauth2.RedirectAllowHtml = "<html><body><p>Thank you for granting access.</p></bod></html>"
loOauth2.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.
lcUrl = loOauth2.StartAuth()
if (loOauth2.LastMethodSuccess <> .T.) then
    ? loOauth2.LastErrorText
    release loOauth2
    return
endif

// 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.
loHttp = createobject("CkHttp")
loSbPreCheck = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb(lcUrl,loSbPreCheck)
if ((loHttp.LastStatus <> 200) or (loSbPreCheck.StartsWith("{",.T.) <> .T.)) then
    ? "JSON Error Response:"
    ? loSbPreCheck.GetAsString()
    release loOauth2
    release loHttp
    release loSbPreCheck
    return
endif

// If the HTTP request itself failed, then examine the error.
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loOauth2
    release loHttp
    release loSbPreCheck
    return
endif

// 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.
lnNumMsWaited = 0
do while (lnNumMsWaited < 30000) and (loOauth2.AuthFlowState < 3)
    loOauth2.SleepMs(100)
    lnNumMsWaited = lnNumMsWaited + 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 (loOauth2.AuthFlowState < 3) then
    loOauth2.Cancel()
    ? "No response from the browser!"
    release loOauth2
    release loHttp
    release loSbPreCheck
    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 (loOauth2.AuthFlowState = 5) then
    ? "OAuth2 failed to complete."
    ? loOauth2.FailureInfo
    release loOauth2
    release loHttp
    release loSbPreCheck
    return
endif

if (loOauth2.AuthFlowState = 4) then
    ? "OAuth2 authorization was denied."
    ? loOauth2.AccessTokenResponse
    release loOauth2
    release loHttp
    release loSbPreCheck
    return
endif

if (loOauth2.AuthFlowState <> 3) then
    ? "Unexpected AuthFlowState:" + str(loOauth2.AuthFlowState)
    release loOauth2
    release loHttp
    release loSbPreCheck
    return
endif

? "OAuth2 authorization granted!"
? "Access Token = " + loOauth2.AccessToken

// Get the full JSON response:
loJson = createobject("CkJsonObject")
loJson.Load(loOauth2.AccessTokenResponse)
loJson.EmitCompact = .F.

// 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 (loJson.HasMember("expires_on") <> .T.) then
    loDtExpire = createobject("CkDateTime")
    loDtExpire.SetFromCurrentSystemTime()
    loDtExpire.AddSeconds(loJson.IntOf("expires_in"))
    loJson.AppendString("expires_on",loDtExpire.GetAsUnixTimeStr(.F.))
endif

? loJson.Emit()

// Save the JSON to a file for future requests.
loFac = createobject("CkFileAccess")
loFac.WriteEntireTextFile("qa_data/tokens/dynamicsCrm.json",loJson.Emit(),"utf-8",.F.)


release loOauth2
release loHttp
release loSbPreCheck
release loJson
release loDtExpire
release loFac