Outlook Calendar: Authorize with OAuth2 and PKCE
See more Outlook Calendar Examples
Authorize an interactive desktop application using the Microsoft identity platform v2.0 authorization-code flow with PKCE (S256). This replaces the older public-client example that disabled PKCE, embedded a client secret, requested unrelated file/profile permissions, and printed tokens.
- Register an application in Microsoft Entra. Select personal Microsoft accounts, organizational accounts, or both according to the intended users. Copy the Application (client) ID, not the Object ID.
- Under Authentication, add a Mobile and desktop applications redirect URI of
http://localhost:3017/. This is a local callback handled by Chilkat; it is not a hosted web-backend redirect. - Add the delegated Microsoft Graph
Calendars.ReadWritepermission for this example collection. A basic read-only application can instead useCalendars.ReadBasic; useCalendars.Readwhen fuller event information is required. Tenant consent policies can require an administrator even for delegated access. - Use
commononly with the appropriate app account-type configuration,consumersfor personal accounts only,organizationsfor organizational accounts, or your tenant ID for a single organization. Change both endpoints together.
offline_access requests a refresh token. Save the returned tokens privately and use the access token only for Graph. The saved obtained_at and expires_in describe its lifetime; refresh tokens can also expire or be revoked, so handle a need for interactive sign-in. This example saves a demonstration JSON cache; production applications should use protected credential storage and atomic replacement per account. No token is printed.
This system-browser/loopback example is intended for a machine with an interactive user. Web applications, mobile applications, and headless services need an authentication flow and redirect handling appropriate to their environment. Do not add a client secret to a public desktop application.
Chilkat Visual Basic 6.0 Downloads
Dim success As Long
success = 0
' Assumes Chilkat is unlocked. See Global Unlock Sample.
success = 0
Dim oauth As New ChilkatOAuth2
' Register a Mobile and desktop applications redirect URI: http://localhost:3017/
' Use an account type that matches your app registration (common, consumers, or tenant ID).
oauth.AuthorizationEndpoint = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
oauth.TokenEndpoint = "https://login.microsoftonline.com/common/oauth2/v2.0/token"
oauth.ClientId = "YOUR_APPLICATION_CLIENT_ID"
' Public desktop applications cannot keep a client secret. Use PKCE instead.
oauth.LocalHost = "localhost"
oauth.ListenPort = 3017
oauth.CodeChallenge = 1
oauth.CodeChallengeMethod = "S256"
' ReadWrite covers this collection's create/delete operations. Use ReadBasic for basic lists only.
oauth.Scope = "offline_access https://graph.microsoft.com/Calendars.ReadWrite"
success = oauth.AddAuthQueryParam("prompt","select_account")
If (success <> 1) Then
Debug.Print "Could not configure the authorization request."
Exit Sub
End If
Dim authUrl As String
authUrl = oauth.StartAuth()
If (oauth.LastMethodSuccess <> 1) Then
Debug.Print "Could not start the local authorization listener."
Exit Sub
End If
success = oauth.LaunchBrowser(authUrl)
If (success <> 1) Then
success = oauth.Cancel()
Debug.Print "Could not open the system browser."
Exit Sub
End If
Dim waited As Long
waited = 0
Do While ((oauth.AuthFlowState < 3) And (waited < 180000))
oauth.SleepMs 200
waited = waited + 200
Loop
If (oauth.AuthFlowState < 3) Then
success = oauth.Cancel()
Debug.Print "Authorization timed out."
Exit Sub
End If
If (oauth.AuthFlowState <> 3) Then
Debug.Print "Authorization did not complete. Flow state: " & oauth.AuthFlowState
Exit Sub
End If
Dim token As New ChilkatJsonObject
token.Strict = 1
success = token.Load(oauth.AccessTokenResponse)
If (success <> 1) Then
Debug.Print "Could not parse the token response; existing cache unchanged."
Exit Sub
End If
If ((token.JsonTypeOf("access_token") <> 1) Or (token.StringOfEquals("access_token","",1) = 1)) Then
Debug.Print "Expected a nonempty access_token in the JSON."
Exit Sub
End If
If ((token.JsonTypeOf("refresh_token") <> 1) Or (token.StringOfEquals("refresh_token","",1) = 1)) Then
Debug.Print "Expected a nonempty refresh_token in the JSON."
Exit Sub
End If
If ((token.JsonTypeOf("expires_in") <> 2) Or (token.IntOf("expires_in") <= 0)) Then
Debug.Print "Expected a positive access-token lifetime."
Exit Sub
End If
Dim obtained As New CkDateTime
success = obtained.SetFromCurrentSystemTime()
If (success <> 1) Then
Debug.Print "Could not record the token acquisition time."
Exit Sub
End If
success = token.UpdateString("obtained_at",obtained.GetAsTimestamp(0))
' This file contains credentials. Choose an access-controlled directory for the signed-in account.
Dim fac As New CkFileAccess
success = fac.DirEnsureExists("qa_data/tokens")
If (success <> 1) Then
Debug.Print "Could not create the private token-cache directory."
Exit Sub
End If
success = token.WriteFile("qa_data/tokens/outlookCalendar.json")
If (success <> 1) Then
Debug.Print "Could not save the token cache."
Exit Sub
End If
' Never print access_token, refresh_token, or the complete token response.
Debug.Print "Calendar authorization completed; token cache saved."