Microsoft 365: Refresh Mail OAuth2 Tokens
See more Office365 Examples
Exchange a saved delegated refresh token for a new access token without displaying a browser. Use the same app registration and authority as the original authorization. Save any rotated refresh token and the new lifetime information. On a rejected or malformed response, this example preserves the previous cache; an expired/revoked grant or interaction-required response needs interactive authorization again.
Read and update qa_data/tokens/office365.json in a private working directory. Serialize access to the cache; production storage should support atomic replacement and protect credentials. A successful refresh does not enable a disabled mail protocol. Client-credentials tokens have no refresh token; request a new application token instead.
Put {"client_id":"YOUR_APPLICATION_ID"} in private microsoft-oauth-client.json for a public desktop app. An existing confidential-client registration must also supply its client_secret from protected configuration; never distribute that secret in a public app. Replace common in the token endpoint with your tenant ID when matching a tenant-specific authorization.
Authorize first: desktop PKCE example. This is delegated background access after consent, not permanently unattended application authentication.
Microsoft reference documentation
Chilkat Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loToken
LOCAL loOauth
LOCAL loClient
LOCAL loFresh
LOCAL loObtained
lnSuccess = 0
* Assumes Chilkat is unlocked. See Global Unlock Sample.
loToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loToken.LoadFile("qa_data/tokens/office365.json")
IF (lnSuccess <> 1) THEN
? "Could not read qa_data/tokens/office365.json from the private working directory."
RELEASE loToken
CANCEL
ENDIF
IF ((loToken.JsonTypeOf("refresh_token") <> 1) OR (loToken.StringOfEquals("refresh_token","",1) = 1)) THEN
? "Authorize the account for offline access first."
RELEASE loToken
CANCEL
ENDIF
loOauth = CreateObject('Chilkat.OAuth2')
loOauth.TokenEndpoint = "https://login.microsoftonline.com/common/oauth2/v2.0/token"
* For public clients the private configuration contains only client_id.
* For an existing confidential client it also contains client_secret.
loClient = CreateObject('Chilkat.JsonObject')
lnSuccess = loClient.LoadFile("microsoft-oauth-client.json")
IF (lnSuccess <> 1) THEN
? "Could not load the private OAuth client configuration."
RELEASE loToken
RELEASE loOauth
RELEASE loClient
CANCEL
ENDIF
IF ((loClient.JsonTypeOf("client_id") <> 1) OR (loClient.StringOfEquals("client_id","",1) = 1)) THEN
? "A matching client_id is required."
RELEASE loToken
RELEASE loOauth
RELEASE loClient
CANCEL
ENDIF
loOauth.ClientId = loClient.StringOf("client_id")
IF (loClient.JsonTypeOf("client_secret") = 1) THEN
loOauth.ClientSecret = loClient.StringOf("client_secret")
ENDIF
* Use the same registration and authority as the original authorization.
loOauth.RefreshToken = loToken.StringOf("refresh_token")
lnSuccess = loOauth.RefreshAccessToken()
IF (lnSuccess <> 1) THEN
? "Refresh failed. Check the OAuth client and grant. A revoked or expired grant requires fresh consent."
RELEASE loToken
RELEASE loOauth
RELEASE loClient
CANCEL
ENDIF
loFresh = CreateObject('Chilkat.JsonObject')
lnSuccess = loFresh.Load(loOauth.AccessTokenResponse)
IF (lnSuccess <> 1) THEN
? "Could not parse the refresh response."
RELEASE loToken
RELEASE loOauth
RELEASE loClient
RELEASE loFresh
CANCEL
ENDIF
IF ((loFresh.JsonTypeOf("access_token") <> 1) OR (loFresh.StringOfEquals("access_token","",1) = 1)) THEN
? "The refresh response did not contain an access token."
RELEASE loToken
RELEASE loOauth
RELEASE loClient
RELEASE loFresh
CANCEL
ENDIF
IF ((loFresh.JsonTypeOf("refresh_token") <> 1) OR (loFresh.StringOfEquals("refresh_token","",1) = 1)) THEN
loFresh.UpdateString("refresh_token",loToken.StringOf("refresh_token"))
ENDIF
IF ((loFresh.HasMember("scope") <> 1) AND (loToken.JsonTypeOf("scope") = 1)) THEN
loFresh.UpdateString("scope",loToken.StringOf("scope"))
ENDIF
* Persist the rotated refresh token. Retain the previous one only if the response omits it.
* Use the new expires_in, not the old response's expiration information.
loObtained = CreateObject('Chilkat.CkDateTime')
loObtained.SetFromCurrentSystemTime()
loFresh.UpdateString("obtained_at",loObtained.GetAsTimestamp(0))
lnSuccess = loFresh.WriteFile("qa_data/tokens/office365.json")
IF (lnSuccess <> 1) THEN
? "Could not save the refreshed credentials."
RELEASE loToken
RELEASE loOauth
RELEASE loClient
RELEASE loFresh
RELEASE loObtained
CANCEL
ENDIF
? "Refreshed the access token."
RELEASE loToken
RELEASE loOauth
RELEASE loClient
RELEASE loFresh
RELEASE loObtained