Lua Requires Chilkat v10.1.2+

Salesforce OAuth2 Refresh Access Token

See more OAuth2 Examples

Demonstrates how to refresh a Salesforce Access Token. 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.
-- This example loads the JSON access token file
-- saved by this example: Get SalesForce OAuth2 Access Token via Authorization Flow

local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/_salesforce.json")
if not success then
    print("Failed to load _salesforce.json")
    return
end

-- This is an example of a Salesforce OAuth2 access token to be refreshed:

-- {
--   "access_token": "00D41000....uLZBpT6",
--   "refresh_token": "5Aep....25xdGgkrV",
--   "signature": "cjTbSc5DvcKpaMoRTzuQTJLb1tcMw8LEO01flq4aMD4=",
--   "scope": "refresh_token id",
--   "instance_url": "https://d41000000f8a0eak-dev-ed.my.salesforce.com",
--   "id": "https://login.salesforce.com/id/00D41000000F8A0EAK/005410000....xAAE",
--   "token_type": "Bearer",
--   "issued_at": "1738348388166"
-- }

local oauth2 = chilkat.OAuth2.new()

oauth2.token_endpoint = "https://login.salesforce.com/services/oauth2/token"

-- Replace this with your actual client ID (Consumer Key)
oauth2.client_id = "CLIENT_ID"

-- Note: The client secret is not required because we configured our Connected App
-- to not require it for the refresh flow.  See the screenshot below.

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

-- The response contains a new access token, but we must keep
-- our existing refresh token for when we need to refresh again in the future.
jsonToken:update_string("access_token", oauth2.access_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/_salesforce.json", "utf-8", false)

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

-- --------------------------------------------------------------------------
-- Here's a screenshot of a Salesforce Connected App
-- which does not requires the secret for the authorization or refresh flow.
--