Lua

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?

Lua

local chilkat = require("chilkat")

-- 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.

local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/hotmail.json")
if not success then
    print("Failed to load office365.json")
    return
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"
-- }

local oauth2 = chilkat.OAuth2.new()

-- See Microsoft OAuth2 Authorization Endpoint
oauth2.token_endpoint = "https://login.microsoftonline.com/common/oauth2/v2.0/token"

-- Replace this with your actual App Registration's Application (client) ID.
oauth2.client_id = "CLIENT_ID"

-- Get the "refresh_token"
oauth2.refresh_token = jsonToken:string_of("refresh_token")

-- Send the HTTP POST to refresh the access token..
success = oauth2:refresh_access_token()
if not success then
    print(oauth2.last_error_text)
    return
end

print(oauth2.last_error_text)

print("New access token: " .. oauth2.access_token)
print("New refresh token: " .. oauth2.refresh_token)

-- Update the JSON with the new tokens.
jsonToken:update_string("access_token", oauth2.access_token)
jsonToken:update_string("refresh_token", oauth2.refresh_token)

-- Save the new JSON access token response to a file.
local sbJson = chilkat.StringBuilder.new()
jsonToken.emit_compact = false
jsonToken:emit_sb(sbJson)
sbJson:write_file("qa_data/tokens/hotmail.json", "utf-8", false)

print("OAuth2 authorization granted!")
print("New Access Token = " .. oauth2.access_token)