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

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

let 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.set_listen_port(3017);

oauth2.set_authorization_endpoint("https://login.twinfield.com/auth/authentication/connect/authorize");
oauth2.set_token_endpoint("https://login.twinfield.com/auth/authentication/connect/token");

// Replace these with actual values.
oauth2.set_client_id("CLIENT_ID");
oauth2.set_client_secret("CLIENT_SECRET");

oauth2.set_scope("openid twf.user twf.organisation twf.organisationUser offline_access");

oauth2.set_code_challenge(true);
oauth2.set_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.set_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.
let Ok(url) = oauth2.start_auth() else {
    println!("{}", oauth2.last_error_text());
    return;
};

println!("url = {}", url);

// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
if oauth2.launch_browser(&url).is_err() {
    println!("{}", oauth2.last_error_text());
    return;
}

// Wait for the user to approve or deny authorization in the browser.
let mut num_ms_waited = 0;
while (num_ms_waited < 90000) && (oauth2.auth_flow_state() < 3) {
    oauth2.sleep_ms(100);
    num_ms_waited = num_ms_waited + 100;
}

// 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 {
    let _ = oauth2.cancel();
    println!("No response from the browser!");
    return;
}

// 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 {
    println!("OAuth2 failed to complete.");
    println!("{}", oauth2.failure_info());
    return;
}

if oauth2.auth_flow_state() == 4 {
    println!("OAuth2 authorization was denied.");
    println!("{}", oauth2.access_token_response());
    return;
}

if oauth2.auth_flow_state() != 3 {
    println!("Unexpected AuthFlowState:{}", oauth2.auth_flow_state());
    return;
}

println!("OAuth2 authorization granted!");
println!("Access Token = {}", oauth2.access_token());

// Get the full JSON response:
let json = chilkat::JsonObject::new();
let _ = json.load(&oauth2.access_token_response());
json.set_emit_compact(false);

// The JSON response looks like this:

println!("{}", json.emit().unwrap_or_default());

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