Lua Requires Chilkat v10.1.2+

Twinfield OAuth2 for Desktop App or Script

See more OAuth2 Examples

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

local chilkat = require("chilkat")

-- For more information about the OAuth2, see OAuth 2.0 Authorization Flow

local oauth2 = chilkat.OAuth2.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.listen_port = 3017

oauth2.authorization_endpoint = "https://login.twinfield.com/auth/authentication/connect/authorize"
oauth2.token_endpoint = "https://login.twinfield.com/auth/authentication/connect/token"

-- Replace these with actual values.
oauth2.client_id = "CLIENT_ID"
oauth2.client_secret = "CLIENT_SECRET"

oauth2.scope = "openid twf.user twf.organisation twf.organisationUser offline_access"

oauth2.code_challenge = true
oauth2.code_challenge_method = "S256"

-- Twinfield requires that the request to exchange the authorization code for a token must be a GET.
-- (In most cases, OAuth2 is implemented where the exchange for token HTTP request is a POST.)
-- Note: The exchange-for-token happens within Chilkat in a background thread.  After the user interactively
-- accepts or denies authorization, the browser receives the response and redirects to localhost:<port>,
-- where Chilkat is waiting on a background thread to receive the redirect, process it, and then send the HTTP request
-- to exchange the code for a token.  This happens internally while your code below is waiting for the authorization..)
oauth2.uncommon_options = "EXCHANGE_CODE_FOR_TOKEN_USING_GET"

-- Begin the OAuth2 Authorization code 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

print("url = " .. url)

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

-- Get the full JSON response:
local json = chilkat.JsonObject.new()
json:load(oauth2.access_token_response)
json.emit_compact = false

-- The JSON response looks like this:

print(json:emit())

-- Save the JSON to a file for future requests.
local fac = chilkat.FileAccess.new()
fac:write_entire_text_file("qa_data/tokens/twinfield.json", json:emit(), "utf-8", false)