Lua Requires Chilkat v10.1.2+

Get a Xero OAuth2 Access Token

See more OAuth2 Examples

Gets a Xero OAuth2 access token. Lua

local chilkat = require("chilkat")

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

local oauth2 = chilkat.OAuth2.new()

-- For Xero OAuth2, set the listen port equal to the port used
-- in the Authorized Redirect URL for the Client ID.
-- For example, in this case the Authorized Redirect URL would be http://localhost:55568/
-- Your app should choose a port not likely not used by any other application.
-- See Xero OAuth2 for Desktop Apps for more information.
oauth2.listen_port = 55568

oauth2.authorization_endpoint = "https://login.xero.com/identity/connect/authorize"
oauth2.token_endpoint = "https://identity.xero.com/connect/token"

-- Replace these with actual values.
oauth2.client_id = "XERO_APP_OAUTH2_CLIENT_ID"
oauth2.client_secret = "XERO_APP_OAUTH2_CLIENT_SECRET"
oauth2.use_basic_auth = true

-- See https://developer.xero.com/documentation/oauth2/scopes for a complete list of scopes.
-- You will need to change the scopes depending on what access is needed..
oauth2.scope = "openid profile email accounting.transactions accounting.attachments accounting.settings payroll.employees offline_access"

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

-- 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/xero-access-token.json", "utf-8", false)

-- The saved JSON response looks like this:

--     {
--      "access_token": "...",
--      "token_type": "Bearer",
--      "expires_in": 3600,
--      "refresh_token": "..."
--     }
--
print("OAuth2 authorization granted!")
print("Access Token = " .. oauth2.access_token)