Dart

Microsoft Graph Calendar OAuth2 Access Token

See more Microsoft Calendar Examples

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

The 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.

Dart

import 'package:chilkat/chilkat.dart';

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

  final oauth2 = 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.
  oauth2.listenPort = 3017;

  oauth2.authorizationEndpoint = 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
  oauth2.tokenEndpoint = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';

  // Replace these with actual values.
  oauth2.clientId = 'MICROSOFT-GRAPH-CLIENT-ID';
  // This is your app password:
  oauth2.clientSecret = 'MICROSOFT-GRAPH-CLIENT-SECRET';

  oauth2.codeChallenge = 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 must include the "offline_access" scope
  oauth2.scope = '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.
  final String url;
  try {
    url = oauth2.startAuth();
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Launch the system's default browser navigated to the URL.
  try {
    oauth2.launchBrowser(url);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Now wait for the authorization.
  // We'll wait for a max of 30 seconds.
  var numMsWaited = 0;
  while ((numMsWaited < 30000) && (oauth2.authFlowState < 3)) {
    oauth2.sleepMs(100);
    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 (oauth2.authFlowState < 3) {
    oauth2.cancel();
    print('No response from the browser!');
    return;
  }

  // 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) {
    print('OAuth2 failed to complete.');
    print(oauth2.failureInfo);
    return;
  }

  if (oauth2.authFlowState == 4) {
    print('OAuth2 authorization was denied.');
    print(oauth2.accessTokenResponse);
    return;
  }

  if (oauth2.authFlowState != 3) {
    print('Unexpected AuthFlowState:${oauth2.authFlowState}');
    return;
  }

  print('OAuth2 authorization granted!');
  print('Access Token = ${oauth2.accessToken}');

  // Get the full JSON response:
  final json = CkJsonObject();
  json.load(oauth2.accessTokenResponse);
  json.emitCompact = false;

  // The JSON response looks like this:

  // {
  //   "token_type": "Bearer",
  //   "scope": "openid profile User.ReadWrite Calendars.ReadWrite 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 (!json.hasMember('expires_on')) {
    final dtExpire = CkDateTime();
    dtExpire.setFromCurrentSystemTime();
    dtExpire.addSeconds(json.intOf('expires_in'));
    json.appendString('expires_on', dtExpire.getAsUnixTimeStr(false));
  }

  print(json.emit());

  // Save the JSON to a file for future requests.
  final fac = CkFileAccess();
  fac.writeEntireTextFile('qa_data/tokens/msGraphCalendar.json', json.emit(), 'utf-8', false);
}