Rust Requires Chilkat v10.1.2+

Get a Xero OAuth2 Access Token

See more OAuth2 Examples

Gets a Xero OAuth2 access token. Rust

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

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

oauth2.set_authorization_endpoint("https://login.xero.com/identity/connect/authorize");
oauth2.set_token_endpoint("https://identity.xero.com/connect/token");

// Replace these with actual values.
oauth2.set_client_id("XERO_APP_OAUTH2_CLIENT_ID");
oauth2.set_client_secret("XERO_APP_OAUTH2_CLIENT_SECRET");
oauth2.set_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.set_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.
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;
}

// Save the full JSON access token response to a file.
let sb_json = chilkat::StringBuilder::new();
let _ = sb_json.append(&oauth2.access_token_response());
let _ = sb_json.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": "..."
// 	}
// 
println!("OAuth2 authorization granted!");
println!("Access Token = {}", oauth2.access_token());