(PHP Extension) Microsoft Graph -- Renew Expiring Access Token (Azure AD v2.0 Endpoint)

Demonstrates how to renew an expiring access token using the refresh token. This example is for renewing an access token using the Azure AD v2.0 endpoint (not the Azure AD endpoint).

An app needs to watch for the expiration of these tokens and renew the expiring access token before the refresh token expires.

This example requires Chilkat v9.5.0.67 or greater.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

// We previously obtained an access token and saved the JSON to a file using this example:
// Get Access Token using Azure AD v2.0 Endpoint

// This example will examine the JSON and expiration date, and if near expiration will
// refresh the access token.

$json = new CkJsonObject();
$success = $json->LoadFile('qa_data/tokens/microsoftGraph.json');
if ($success != true) {
    exit;
}

// The contents of the JSON look like this:
// {
//   "token_type": "Bearer",
//   "scope": "User.Read Mail.ReadWrite Mail.Send",
//   "expires_in": 3600,
//   "ext_expires_in": 0,
//   "access_token": "EwBAA8l6B...",
//   "refresh_token": "MCRMdbe6Cd...",
//   "id_token": "eyJ0eXAiOiJ...",
//   "expires_on": "1494112119"
// }

// The "expires_on" value is a Unix time.
$dtExpire = new CkDateTime();
$dtExpire->SetFromUnixTime(false,$json->IntOf('expires_on'));

// If this date/time expires within 10 minutes of the current system time, refresh the token.
if ($dtExpire->ExpiresWithin(10,'minutes') != true) {
    print 'No need to refresh, the access token won't expire within the next 10 minutes.' . "\n";
    exit;
}

// OK, we need to refresh the access token by sending a POST like this:
// 

// 	POST https://login.microsoftonline.com/common/oauth2/v2.0/token HTTP/1.1
// 	Host: login.microsoftonline.com
// 	Content-Type: application/x-www-form-urlencoded
// 	Content-Length: ***
// 
// 	grant_type=refresh_token
// 	&redirect_uri=http%3A%2F%2Flocalhost%3A3017%2F
// 	&client_id=8b8539cd-7b75-427f-bef1-4a6264fd4940
// 	&client_secret=PJW3dznGfyNSm3rM9aHeXWGKsTMepKXT1Eqy45XXdU4%3D
// 	&refresh_token=AAABAAAAvPM1KaPlrEqdFSBzjqfTGM74--...

$req = new CkHttpRequest();
$req->AddParam('grant_type','refresh_token');
$req->AddParam('redirect_uri','http://localhost:3017/');
$req->AddParam('client_id','MICROSOFT-GRAPH-CLIENT-ID');
$req->AddParam('client_secret','MICROSOFT-GRAPH-CLIENT-SECRET');
$req->AddParam('refresh_token',$json->stringOf('refresh_token'));

$http = new CkHttp();

// resp is a CkHttpResponse
$resp = $http->PostUrlEncoded('https://login.microsoftonline.com/common/oauth2/v2.0/token',$req);
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

// Load the JSON response.
$json->Load($resp->bodyStr());
$json->put_EmitCompact(false);

// Show the JSON response.
print $json->emit() . "\n";

print 'Response status code: ' . $resp->get_StatusCode() . "\n";

// If the response status code is not 200, then it's an error.
if ($resp->get_StatusCode() != 200) {
    exit;
}

// 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') != true) {
    $dtExpire->SetFromCurrentSystemTime();
    $dtExpire->AddSeconds($json->IntOf('expires_in'));
    $json->AppendString('expires_on',$dtExpire->getAsUnixTimeStr(false));
}

// Save the refreshed access token JSON to a file for future requests.
$fac = new CkFileAccess();
$fac->WriteEntireTextFile('qa_data/tokens/microsoftGraph.json',$json->emit(),'utf-8',false);

?>