(Mono C#) 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.

Chilkat .NET Downloads Chilkat .NET Assemblies Chilkat for .NET Core Chilkat for Mono

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

Chilkat.OAuth2 oauth2 = new Chilkat.OAuth2();
bool success;

// 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.ListenPort = 3017;

oauth2.AuthorizationEndpoint = "https://login.twinfield.com/auth/authentication/connect/authorize";
oauth2.TokenEndpoint = "https://login.twinfield.com/auth/authentication/connect/token";

// Replace these with actual values.
oauth2.ClientId = "CLIENT_ID";
oauth2.ClientSecret = "CLIENT_SECRET";

oauth2.Scope = "openid twf.user twf.organisation twf.organisationUser offline_access";

oauth2.CodeChallenge = true;
oauth2.CodeChallengeMethod = "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.UncommonOptions = "EXCHANGE_CODE_FOR_TOKEN_USING_GET";

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
string url = oauth2.StartAuth();
if (oauth2.LastMethodSuccess != true) {
    Debug.WriteLine(oauth2.LastErrorText);
    return;
}

// At this point, your application should load the URL in a browser.
// For example, 
// in C#: System.Diagnostics.Process.Start(url);
// in Java: Desktop.getDesktop().browse(new URI(url));
// in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
//              wsh.Run url
// in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
// in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
// The Microsoft account owner would interactively accept or deny the authorization request.

// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...

// Now wait for the authorization.
// We'll wait for a max of 60 seconds.
int numMsWaited = 0;
while ((numMsWaited < 60000) && (oauth2.AuthFlowState < 3)) {
    oauth2.SleepMs(100);
    numMsWaited = numMsWaited + 100;
}

// 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.AuthFlowState < 3) {
    oauth2.Cancel();
    Debug.WriteLine("No response from the browser!");
    return;
}

// 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.AuthFlowState == 5) {
    Debug.WriteLine("OAuth2 failed to complete.");
    Debug.WriteLine(oauth2.FailureInfo);
    return;
}

if (oauth2.AuthFlowState == 4) {
    Debug.WriteLine("OAuth2 authorization was denied.");
    Debug.WriteLine(oauth2.AccessTokenResponse);
    return;
}

if (oauth2.AuthFlowState != 3) {
    Debug.WriteLine("Unexpected AuthFlowState:" + Convert.ToString(oauth2.AuthFlowState));
    return;
}

Debug.WriteLine("OAuth2 authorization granted!");
Debug.WriteLine("Access Token = " + oauth2.AccessToken);

// Get the full JSON response:
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.Load(oauth2.AccessTokenResponse);
json.EmitCompact = false;

// The JSON response looks like this:

Debug.WriteLine(json.Emit());

// Save the JSON to a file for future requests.
Chilkat.FileAccess fac = new Chilkat.FileAccess();
fac.WriteEntireTextFile("qa_data/tokens/twinfield.json",json.Emit(),"utf-8",false);