(PowerShell) Twinfield OAuth2 for Desktop App or Script

See more OAuth2 Examples

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$oauth2 = New-Object Chilkat.OAuth2

# 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 Authorization code flow.  This returns a URL that should be loaded in a browser.
$url = $oauth2.StartAuth()
if ($oauth2.LastMethodSuccess -ne $true) {
    $($oauth2.LastErrorText)
    exit
}

$("url = " + $url)

# Launch the default browser on the system and navigate to the url.
# The LaunchBrowser method was added in Chilkat v10.1.2.
$success = $oauth2.LaunchBrowser($url)
if ($success -eq $false) {
    $($oauth2.LastErrorText)
    exit
}

# Wait for the user to approve or deny authorization in the browser.
$numMsWaited = 0
while (($numMsWaited -lt 90000) -and ($oauth2.AuthFlowState -lt 3)) {
    $oauth2.SleepMs(100)
    $numMsWaited = $numMsWaited + 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.AuthFlowState -lt 3) {
    $oauth2.Cancel()
    $("No response from the browser!")
    exit
}

# 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.AuthFlowState -eq 5) {
    $("OAuth2 failed to complete.")
    $($oauth2.FailureInfo)
    exit
}

if ($oauth2.AuthFlowState -eq 4) {
    $("OAuth2 authorization was denied.")
    $($oauth2.AccessTokenResponse)
    exit
}

if ($oauth2.AuthFlowState -ne 3) {
    $("Unexpected AuthFlowState:" + $oauth2.AuthFlowState)
    exit
}

$("OAuth2 authorization granted!")
$("Access Token = " + $oauth2.AccessToken)

# Get the full JSON response:
$json = New-Object Chilkat.JsonObject
$json.Load($oauth2.AccessTokenResponse)
$json.EmitCompact = $false

# The JSON response looks like this:

$($json.Emit())

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