Lua Requires Chilkat v10.1.2+

Salesforce OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to get a Salesforce OAuth2 access token from a desktop application or script. Lua

local chilkat = require("chilkat")

-- To further clarify, see OAuth 2.0 Authorization Flow

local oauth2 = chilkat.OAuth2.new()

-- This should be the port in the localhost callback URL for your connected app.
-- The callback URL would look like "http://localhost:3017/" if the port number is 3017.
oauth2.listen_port = 3017

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

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

-- We don't have to include the client secret.
-- See the screenshot of our Connected App below..

-- This is for Require Proof Key for Code Exchange (PKCE)
-- See OAuth2 PKCE Explained
oauth2.code_challenge = true
oauth2.code_challenge_method = "S256"

-- To force the OAuth consent screen to reappear (even if previously granted), use:
oauth2:add_auth_query_param("prompt", "consent")

-- Begin the OAuth2 authorization flow.  This returns a URL that should be loaded in a browser.
local url = oauth2:start_auth()
if not oauth2.last_method_success then
    print(oauth2.last_error_text)
    return
end

-- Launch the default browser on the system and navigate to the url.
local success = oauth2:launch_browser(url)
if not success then
    print(oauth2.last_error_text)
    return
end

-- Wait for the user to approve or deny authorization in the browser.
local numMsWaited = 0
while (numMsWaited < 90000) and (oauth2.auth_flow_state < 3) do
    oauth2:sleep_ms(100)
    numMsWaited = numMsWaited + 100
end

-- If the browser does not respond within the specified time, AuthFlowState will be:
--
-- 1: Waiting for Redirect – The OAuth2 background thread is waiting for the browser's redirect request.
-- 2: Waiting for Final Response – The thread is awaiting the final access token response.
-- In either case, cancel the background task initiated by StartAuth.

if oauth2.auth_flow_state < 3 then
    oauth2:cancel()
    print("No response from the browser!")
    return
end

-- Check AuthFlowState to determine if authorization was granted, denied, or failed:
--
-- 3: Success – OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
-- 4: Access Denied – OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
-- 5: Failure – OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

if oauth2.auth_flow_state == 5 then
    print("OAuth2 failed to complete.")
    print(oauth2.failure_info)
    return
end

if oauth2.auth_flow_state == 4 then
    print("OAuth2 authorization was denied.")
    print(oauth2.access_token_response)
    return
end

if oauth2.auth_flow_state ~= 3 then
    print("Unexpected AuthFlowState:" .. oauth2.auth_flow_state)
    return
end

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

-- Save the full JSON access token response to a file.
local sbJson = chilkat.StringBuilder.new()
sbJson:append(oauth2.access_token_response)
sbJson:write_file("qa_data/tokens/_salesforce.json", "utf-8", false)

-- The saved JSON response looks like this:

-- {
--   "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"
-- }

-- --------------------------------------------------------------------------
-- Here's a screenshot of a Salesforce Connected App
-- with the correct Callback URL for this example,
-- and also selects "Require Proof Key for Code Exchange (PKCE)"
-- and does not requires the secret for the authorization or refresh flow,
-- and also allows for the Client Credentials flow.
--