Pascal (Lazarus/Delphi)

Hotmail Refresh Access Token (also for Live.com, Outlook.com)

See more OAuth2 Examples

An OAuth2 access token is typically valid for 1 hour. Interaction with the Hotmail account owner via a browser is only needed for getting the initial access token. Once you have it, it can be continually refreshed without user interaction for a long time.

See: How Long can an OAuth2 Access Token be Refreshed?

Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.OAuth2,
  Chilkat.StringBuilder,
  Chilkat.JsonObject;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  jsonToken: TJsonObject;
  oauth2: TOAuth2;
  sbJson: TStringBuilder;

begin
  success := False;

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

  //  It is assumed we previously obtained an OAuth2 access token.

  //  Note: Refreshing an access token does not require user-interaction.  
  //  Only the act of getting the initial access token requires interactive authorization from the Hotmail account owner 
  //  (i.e. a browser is displayed and the Hotmail account owner authorizes access by the app).

  //  Once you have the initial access token, it can be refreshed for a long time.
  //  A typical strategy is to write your application to automatically refresh the access token 
  //  when authentication fails, and then retry the operation with the new access token.

  jsonToken := TJsonObject.Create;
  success := jsonToken.LoadFile('qa_data/tokens/hotmail.json');
  if (success <> True) then
    begin
      WriteLn('Failed to load office365.json');
      Exit;
    end;

  //  The access token JSON looks like this:

  //  {
  //    "token_type": "Bearer",
  //    "scope": "https://outlook.office.com/SMTP.Send https://outlook.office.com/IMAP.AccessAsUser.All https://outlook.office.com/POP.AccessAsUser.All",
  //    "expires_in": 3600,
  //    "ext_expires_in": 3600,
  //    "access_token": "EwBoA+ ... 7pOYcWr5pFwQgI=",
  //    "refresh_token": "M.C546_BL2.0.U.-CkW ... g5CKSlDBQ$$",
  //    "id_token": "eyJ0e ... 2iiu5iqBK9n7s3A"
  //  }

  oauth2 := TOAuth2.Create;

  //  See Microsoft OAuth2 Authorization Endpoint
  oauth2.TokenEndpoint := 'https://login.microsoftonline.com/common/oauth2/v2.0/token';

  //  Replace this with your actual App Registration's Application (client) ID.
  oauth2.ClientId := 'CLIENT_ID';

  //  Get the "refresh_token"
  oauth2.RefreshToken := jsonToken.StringOf('refresh_token');

  //  Send the HTTP POST to refresh the access token..
  success := oauth2.RefreshAccessToken();
  if (success <> True) then
    begin
      WriteLn(oauth2.LastErrorText);
      Exit;
    end;
  WriteLn(oauth2.LastErrorText);

  WriteLn('New access token: ' + oauth2.AccessToken);
  WriteLn('New refresh token: ' + oauth2.RefreshToken);

  //  Update the JSON with the new tokens.
  jsonToken.UpdateString('access_token',oauth2.AccessToken);
  jsonToken.UpdateString('refresh_token',oauth2.RefreshToken);

  //  Save the new JSON access token response to a file.
  sbJson := TStringBuilder.Create;
  jsonToken.EmitCompact := False;
  jsonToken.EmitSb(sbJson);
  sbJson.WriteFile('qa_data/tokens/hotmail.json','utf-8',False);

  WriteLn('OAuth2 authorization granted!');
  WriteLn('New Access Token = ' + oauth2.AccessToken);


  jsonToken.Free;
  oauth2.Free;
  sbJson.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.