(Tcl) Dynamics CRM OAuth2 Access Token

See more OAuth2 Examples

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

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

# To further clarify, see OAuth 2.0 Authorization Flow

set oauth2 [new_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.
CkOAuth2_put_ListenPort $oauth2 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
CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize"
CkOAuth2_put_TokenEndpoint $oauth2 "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token"

# Replace these with actual values.
CkOAuth2_put_ClientId $oauth2 "DYNAMICS-CRM-CLIENT-ID"
CkOAuth2_put_ClientSecret $oauth2 "DYNAMICS-CRM-SECRET-KEY"

CkOAuth2_put_Resource $oauth2 "https://mydynamicsdomain.api.crm.dynamics.com"

CkOAuth2_put_RedirectAllowHtml $oauth2 "<html><body><p>Thank you for granting access.</p></bod></html>"
CkOAuth2_put_RedirectDenyHtml $oauth2 "<html><body><p>Maybe next time...</p></bod></html>"

# Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
set url [CkOAuth2_startAuth $oauth2]
if {[CkOAuth2_get_LastMethodSuccess $oauth2] != 1} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

# 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.
set http [new_CkHttp]

set sbPreCheck [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http $url $sbPreCheck]
if {expr [[CkHttp_get_LastStatus $http] != 200]  ||  [[CkStringBuilder_StartsWith $sbPreCheck "{" 1] != 1]} then {
    puts "JSON Error Response:"
    puts [CkStringBuilder_getAsString $sbPreCheck]
    delete_CkOAuth2 $oauth2
    delete_CkHttp $http
    delete_CkStringBuilder $sbPreCheck
    exit
}

# If the HTTP request itself failed, then examine the error.
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkOAuth2 $oauth2
    delete_CkHttp $http
    delete_CkStringBuilder $sbPreCheck
    exit
}

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

# Launch the default browser on the system and navigate to the url.
# The LaunchBrowser method was added in Chilkat v10.1.2.
set success [CkOAuth2_LaunchBrowser $oauth2 $url]
if {$success == 0} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    delete_CkHttp $http
    delete_CkStringBuilder $sbPreCheck
    exit
}

# Wait for the user to approve or deny authorization in the browser.
set numMsWaited 0
while {expr [$numMsWaited < 90000]  &&  [[CkOAuth2_get_AuthFlowState $oauth2] < 3]} {
    CkOAuth2_SleepMs $oauth2 100
    set numMsWaited [expr $numMsWaited + 100]
}

# If the browser does not respond within the specified time, AuthFlowState will be:
# 
# 1: Waiting for Redirect – The OAuth2 background thread is waiting for the browser's redirect request.
# 2: Waiting for Final Response – The thread is awaiting the final access token response.
# In either case, cancel the background task initiated by StartAuth.

if {[CkOAuth2_get_AuthFlowState $oauth2] < 3} then {
    CkOAuth2_Cancel $oauth2
    puts "No response from the browser!"
    delete_CkOAuth2 $oauth2
    delete_CkHttp $http
    delete_CkStringBuilder $sbPreCheck
    exit
}

# Check AuthFlowState to determine if authorization was granted, denied, or failed:
# 
# 3: Success – OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
# 4: Access Denied – OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
# 5: Failure – OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

if {[CkOAuth2_get_AuthFlowState $oauth2] == 5} then {
    puts "OAuth2 failed to complete."
    puts [CkOAuth2_failureInfo $oauth2]
    delete_CkOAuth2 $oauth2
    delete_CkHttp $http
    delete_CkStringBuilder $sbPreCheck
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] == 4} then {
    puts "OAuth2 authorization was denied."
    puts [CkOAuth2_accessTokenResponse $oauth2]
    delete_CkOAuth2 $oauth2
    delete_CkHttp $http
    delete_CkStringBuilder $sbPreCheck
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] != 3} then {
    puts "Unexpected AuthFlowState:[CkOAuth2_get_AuthFlowState $oauth2]"
    delete_CkOAuth2 $oauth2
    delete_CkHttp $http
    delete_CkStringBuilder $sbPreCheck
    exit
}

puts "OAuth2 authorization granted!"
puts "Access Token = [CkOAuth2_accessToken $oauth2]"

# Get the full JSON response:
set json [new_CkJsonObject]

CkJsonObject_Load $json [CkOAuth2_accessTokenResponse $oauth2]
CkJsonObject_put_EmitCompact $json 0

# 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 {[CkJsonObject_HasMember $json "expires_on"] != 1} then {
    set dtExpire [new_CkDateTime]

    CkDateTime_SetFromCurrentSystemTime $dtExpire
    CkDateTime_AddSeconds $dtExpire [CkJsonObject_IntOf $json "expires_in"]
    CkJsonObject_AppendString $json "expires_on" [CkDateTime_getAsUnixTimeStr $dtExpire 0]
}

puts [CkJsonObject_emit $json]

# Save the JSON to a file for future requests.
set fac [new_CkFileAccess]

CkFileAccess_WriteEntireTextFile $fac "qa_data/tokens/dynamicsCrm.json" [CkJsonObject_emit $json] "utf-8" 0

delete_CkOAuth2 $oauth2
delete_CkHttp $http
delete_CkStringBuilder $sbPreCheck
delete_CkJsonObject $json
delete_CkDateTime $dtExpire
delete_CkFileAccess $fac