Delphi DLL

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

See more Outlook Calendar Examples

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

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.

Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, FileAccess, OAuth2, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
oauth2: HCkOAuth2;
url: PWideChar;
numMsWaited: Integer;
json: HCkJsonObject;
fac: HCkFileAccess;

begin
success := False;

// 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

oauth2 := CkOAuth2_Create();

// 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_putListenPort(oauth2,3017);

CkOAuth2_putAuthorizationEndpoint(oauth2,'https://login.microsoftonline.com/common/oauth2/v2.0/authorize');
CkOAuth2_putTokenEndpoint(oauth2,'https://login.microsoftonline.com/common/oauth2/v2.0/token');

// Replace these with actual values.
CkOAuth2_putClientId(oauth2,'MICROSOFT-GRAPH-CLIENT-ID');
// This is your app password:
CkOAuth2_putClientSecret(oauth2,'MICROSOFT-GRAPH-CLIENT-SECRET');

CkOAuth2_putCodeChallenge(oauth2,False);
// 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
CkOAuth2_putScope(oauth2,'openid profile offline_access user.readwrite calendars.readwrite files.readwrite');

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
url := CkOAuth2__startAuth(oauth2);
if (CkOAuth2_getLastMethodSuccess(oauth2) = False) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// Launch the system's default browser navigated to the URL.
success := CkOAuth2_LaunchBrowser(oauth2,url);
if (success = False) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// Now wait for the authorization.
// We'll wait for a max of 30 seconds.
numMsWaited := 0;
while (numMsWaited < 30000) and (CkOAuth2_getAuthFlowState(oauth2) < 3) do
  begin
    CkOAuth2_SleepMs(oauth2,100);
    numMsWaited := numMsWaited + 100;
  end;

// 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_getAuthFlowState(oauth2) < 3) then
  begin
    CkOAuth2_Cancel(oauth2);
    Memo1.Lines.Add('No response from the browser!');
    Exit;
  end;

// 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_getAuthFlowState(oauth2) = 5) then
  begin
    Memo1.Lines.Add('OAuth2 failed to complete.');
    Memo1.Lines.Add(CkOAuth2__failureInfo(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) = 4) then
  begin
    Memo1.Lines.Add('OAuth2 authorization was denied.');
    Memo1.Lines.Add(CkOAuth2__accessTokenResponse(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) <> 3) then
  begin
    Memo1.Lines.Add('Unexpected AuthFlowState:' + IntToStr(CkOAuth2_getAuthFlowState(oauth2)));
    Exit;
  end;

Memo1.Lines.Add('OAuth2 authorization granted!');
Memo1.Lines.Add('Access Token = ' + CkOAuth2__accessToken(oauth2));

// Get the full JSON response:
json := CkJsonObject_Create();
CkJsonObject_Load(json,CkOAuth2__accessTokenResponse(oauth2));
CkJsonObject_putEmitCompact(json,False);

// The JSON response looks like this:

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

Memo1.Lines.Add(CkJsonObject__emit(json));

// Save the JSON to a file for future requests.
fac := CkFileAccess_Create();
CkFileAccess_WriteEntireTextFile(fac,'qa_data/tokens/outlookCalendar.json',CkJsonObject__emit(json),'utf-8',False);

CkOAuth2_Dispose(oauth2);
CkJsonObject_Dispose(json);
CkFileAccess_Dispose(fac);

end;