PowerShell Requires Chilkat v10.1.2+

Get a Xero OAuth2 Access Token

See more OAuth2 Examples

Gets a Xero OAuth2 access token. PowerShell

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

$success = $false

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

$oauth2 = New-Object Chilkat.OAuth2

#  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.ListenPort = 55568

$oauth2.AuthorizationEndpoint = "https://login.xero.com/identity/connect/authorize"
$oauth2.TokenEndpoint = "https://identity.xero.com/connect/token"

#  Replace these with actual values.
$oauth2.ClientId = "XERO_APP_OAUTH2_CLIENT_ID"
$oauth2.ClientSecret = "XERO_APP_OAUTH2_CLIENT_SECRET"
$oauth2.UseBasicAuth = $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.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.
$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
}

#  Save the full JSON access token response to a file.
$sbJson = New-Object Chilkat.StringBuilder
$sbJson.Append($oauth2.AccessTokenResponse)
$sbJson.WriteFile("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": "..."
#  	}
#  
$("OAuth2 authorization granted!")
$("Access Token = " + $oauth2.AccessToken)