Lua

Authorization Code Flow with PKCE for Native Apps

See more Okta OAuth/OIDC Examples

Demonstrates the authorization code flow with Proof Key for Code Exchange (PKCE) for native apps. In Okta, your app should be defined as shown: Lua

local chilkat = require("chilkat")

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

local oauth2 = chilkat.OAuth2.new()

-- This should be the port in the Login redirect URI for your app.
-- Your app's Login redirect URI should be "http://localhost:3017/" if the port number is 3017.
oauth2.listen_port = 3017

oauth2.authorization_endpoint = "https://{yourOktaDomain}/oauth2/default/v1/authorize"
oauth2.token_endpoint = "https://{yourOktaDomain}/oauth2/default/v1/token"

-- Replace these with actual values.
oauth2.client_id = "OKTA_CLIENT_ID"
oauth2.client_secret = "OKTA_CLIENT_SECRET"

oauth2.code_challenge = true
oauth2.include_nonce = true

-- Make sure to include "offline_access" to get a refresh token included in the final JSON response.
-- Add any additional needed scopes separated by space chars.
oauth2.scope = "openid offline_access"

-- Begin the OAuth2 three-legged 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 to load in browser: " .. url)

-- Launch the system's default browser navigated to the URL.
local success = oauth2:launch_browser(url)
if not success then
    print(oauth2.last_error_text)
    return
end

-- Now wait for the authorization.
-- We'll wait for a max of 60 seconds.
local numMsWaited = 0
while (numMsWaited < 60000) and (oauth2.auth_flow_state < 3) do
    oauth2:sleep_ms(100)
    numMsWaited = numMsWaited + 100
end

-- If there was no response from the browser within 30 seconds, then
-- the AuthFlowState will be equal to 1 or 2.
-- 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
-- 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
-- In that case, cancel the background task started in the call to StartAuth.
if oauth2.auth_flow_state < 3 then
    oauth2:cancel()
    print("No response from the browser!")
    return
end

-- Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
-- The possible AuthFlowState values are:
-- 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
-- 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
-- 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
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
print(json:emit())

-- The JSON response looks like this:

-- {
--   "access_token": "eyJraWQi ... Kn4IiEfOw",
--   "token_type": "Bearer",
--   "expires_in": 3600,
--   "scope": "offline_access openid",
--   "refresh_token": "0jCqotuuUegdjNzB9uuSsfGM2Cu5HnCHUxoJ0yhZ4rs",
--   "id_token": "eyJraWQiO ... 09WGEq3dTRmQF86PzJg"
-- }

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