Ruby

Outlook Calendar OAuth2 Access Token - Using Azure AD v2.0 Endpoint

See more Outlook Calendar Examples

Demonstrates how to get a Microsoft Graph OAuth2 access token from a desktop application or script using scopes for Outlook Calendar.

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.

Ruby

require 'chilkat'

success = false

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

# See more Microsoft Graph OAuth2 examples:
# 
# Microsoft Graph OAuth2 App Authentication using Azure AD
# Microsoft Graph OAuth2 Client Credentials Grant Flow
# Microsoft Graph -- Renew Expiring Access Token (Azure AD v2.0 Endpoint)
# Microsoft Graph -- Renew Expiring Access Token (Azure AD Endpoint)
# Decode Microsoft Graph ID Token
# Microsoft Graph Revoke OAuth2 Access Tokens

oauth2 = Chilkat::CkOAuth2.new()

# 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.put_ListenPort(3017)

oauth2.put_AuthorizationEndpoint("https://login.microsoftonline.com/common/oauth2/v2.0/authorize")
oauth2.put_TokenEndpoint("https://login.microsoftonline.com/common/oauth2/v2.0/token")

# Replace these with actual values.
oauth2.put_ClientId("MICROSOFT-GRAPH-CLIENT-ID")
# This is your app password:
oauth2.put_ClientSecret("MICROSOFT-GRAPH-CLIENT-SECRET")

oauth2.put_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 have to ask for "offline_access" scope
oauth2.put_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.
url = oauth2.startAuth()
if (oauth2.get_LastMethodSuccess() == false)
    print oauth2.lastErrorText() + "\n";
    exit
end

# Launch the system's default browser navigated to the URL.
success = oauth2.LaunchBrowser(url)
if (success == false)
    print oauth2.lastErrorText() + "\n";
    exit
end

# Now wait for the authorization.
# We'll wait for a max of 30 seconds.
numMsWaited = 0
while (numMsWaited < 30000) and (oauth2.get_AuthFlowState() < 3)
    oauth2.SleepMs(100)
    numMsWaited = numMsWaited + 100
end

# 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.get_AuthFlowState() < 3)
    oauth2.Cancel()
    print "No response from the browser!" + "\n";
    exit
end

# 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.get_AuthFlowState() == 5)
    print "OAuth2 failed to complete." + "\n";
    print oauth2.failureInfo() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() == 4)
    print "OAuth2 authorization was denied." + "\n";
    print oauth2.accessTokenResponse() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() != 3)
    print "Unexpected AuthFlowState:" + oauth2.get_AuthFlowState().to_s() + "\n";
    exit
end

print "OAuth2 authorization granted!" + "\n";
print "Access Token = " + oauth2.accessToken() + "\n";

# Get the full JSON response:
json = Chilkat::CkJsonObject.new()
json.Load(oauth2.accessTokenResponse())
json.put_EmitCompact(false)

# The JSON response looks like this:

# {
#   "token_type": "Bearer",
#   "scope": "openid profile User.ReadWrite Calendars.ReadWrite Files.ReadWrite ...",
#   "expires_in": 3600,
#   "ext_expires_in": 3600,
#   "access_token": "EwBAA8l6B...",
#   "refresh_token": "MCRMdbe...",
#   "id_token": "eyJ0eXA..."
# }

print json.emit() + "\n";

# Save the JSON to a file for future requests.
fac = Chilkat::CkFileAccess.new()
fac.WriteEntireTextFile("qa_data/tokens/outlookCalendar.json",json.emit(),"utf-8",false)