Lua Requires Chilkat v10.1.2+

GeoOp OAuth2 Authorisation Code Grant (Public App)

See more OAuth2 Examples

Demonstrates how to get an access token for a GeoOp Third-Party Public Application using the Authorisation Code Grant flow. Lua

local chilkat = require("chilkat")

-- It requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local oauth2 = chilkat.OAuth2.new()

-- This should match the Site URL configured for your GeoOp (non-Server) Application, such as "http://localhost:3017/"
oauth2.listen_port = 3017

oauth2.authorization_endpoint = "https://login.geoop.com/oauth2/code"
oauth2.token_endpoint = "https://login.geoop.com/oauth2/token"

-- Replace the client ID with an actual value.
oauth2.client_id = "GEOOP-APPLICATION-ID"
-- The ClientSecret should remain empty for a GeoOp public application
oauth2.client_secret = ""

-- We need a few special settings for GeoOp
oauth2.scope = "default"
oauth2.code_challenge = false
-- Setting LocalHost equal to "none" prevents the "redirect_uri" query param from being sent in the initial HTTP request.
-- Note: The GeoOp Application should still have a redirect URL specified as "http://localhost:3017/", where the port
-- number matches the ListenPort above.
oauth2.local_host = "none"

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

-- 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 entire JSON response, which includes the access token, for future calls.
-- The JSON AccessTokenResponse looks like this:
-- {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":984236}

local fac = chilkat.FileAccess.new()
fac:write_entire_text_file("qa_data/tokens/geoop.json", oauth2.access_token_response, "utf-8", false)

print("Success.")