(Tcl) Microsoft Graph Group OAuth2 Access Token

Demonstrates how to get a Microsoft Graph OAuth2 access token for the Group API from a desktop application or script. This example uses the Azure AD v2.0 Endpoint.

See https://docs.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0 for more information.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set oauth2 [new_CkOAuth2]

# 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.
CkOAuth2_put_ListenPort $oauth2 3017

CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
CkOAuth2_put_TokenEndpoint $oauth2 "https://login.microsoftonline.com/common/oauth2/v2.0/token"

# Replace these with actual values.
CkOAuth2_put_ClientId $oauth2 "MICROSOFT-GRAPH-CLIENT-ID"
# This is your app password:
CkOAuth2_put_ClientSecret $oauth2 "MICROSOFT-GRAPH-CLIENT-SECRET"

CkOAuth2_put_CodeChallenge $oauth2 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 must include the "offline_access" scope
CkOAuth2_put_Scope $oauth2 "openid profile offline_access user.readwrite group.readwrite.all files.readwrite"

# Begin the OAuth2 three-legged 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
}

# 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 Microsoft 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.
set numMsWaited 0
while {expr [$numMsWaited < 30000]  &&  [[CkOAuth2_get_AuthFlowState $oauth2] < 3]} {
    CkOAuth2_SleepMs $oauth2 100
    set numMsWaited [expr $numMsWaited + 100]
}

# 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 {[CkOAuth2_get_AuthFlowState $oauth2] < 3} then {
    CkOAuth2_Cancel $oauth2
    puts "No response from the browser!"
    delete_CkOAuth2 $oauth2
    exit
}

# 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 {[CkOAuth2_get_AuthFlowState $oauth2] == 5} then {
    puts "OAuth2 failed to complete."
    puts [CkOAuth2_failureInfo $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

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

if {[CkOAuth2_get_AuthFlowState $oauth2] != 3} then {
    puts "Unexpected AuthFlowState:[CkOAuth2_get_AuthFlowState $oauth2]"
    delete_CkOAuth2 $oauth2
    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": "openid profile User.ReadWrite Group.ReadWrite.All Files.ReadWrite User.Read",
#   "expires_in": 3600,
#   "ext_expires_in": 0,
#   "access_token": "EwBAA8l6B...",
#   "refresh_token": "MCRMdbe...",
#   "id_token": "eyJ0eXA..."
# }

# 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/msGraphGroup.json" [CkJsonObject_emit $json] "utf-8" 0

delete_CkOAuth2 $oauth2
delete_CkJsonObject $json
delete_CkDateTime $dtExpire
delete_CkFileAccess $fac