JDBC Driver for Xero

Build 22.0.8479

ヘッドレスマシン

Using OAuth on a Headless Machine

To create Xero data sources on headless servers or other machines on which the 本製品 cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.

  1. Instead of installing the 本製品 on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the 本製品 on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the 本製品 to automatically refresh the access token from the headless machine.

Authorize The Connection

Creating a custom OAuth auth code app is required for the following flow, as PKCE is not supported with it. See カスタムOAuth アプリの作成 for a procedure. You can then follow the procedures below to authenticate and connect to data.

Set the following properties on the headless machine:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to OFF.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

  1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
  2. Open the returned URL in a browser. Log in and grant permissions to the 本製品. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.

Transfer OAuth Settings

Instead of completing the above OAuth flow by hand, you may also follow the steps below to install the 本製品 on another machine, authenticate, and then transfer the resulting OAuth values.

This flow does not require the use of a custom OAuth application.

On a second machine, install the 本製品 and connect with the following properties set:

  • Set InitiateOAuth to GETANDREFRESH.
  • OAuthSettingsLocation: Set this to a writable text file.

Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the 本製品 to enable the automatic refreshing of the access token.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479