Connections > Xero connection properties > Connect to Xero

Connect to Xero

Let's configure the Xero connection properties to connect to Xero.

Before you begin

Before you get started, you'll need to get the relevant configuration details from your Xero account based on the authentication type that you want to configure.

Check out Prepare for authentication to learn more about the authentication prerequisites.

Xero connection details

When you create a Xero connection, configure the connection properties.

The following table describes the Xero connection properties:

Connection property	Description
Connection Name	Name of the connection. Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -, Maximum length is 255 characters.
Description	Description of the connection. Maximum length is 4000 characters.
Use Secret Vault	Stores sensitive credentials for this connection in the secrets manager that is configured for your organization. This property appears only if secrets manager is set up for your organization. This property is not supported by Data Ingestion and Replication and the Data Access Management services. When you enable the secret vault in the connection, you can select the credentials that the Secure Agent retrieves from the secrets manager. If you don't enable this option, the credentials are stored in the repository or on a local Secure Agent, depending on how your organization is configured. Note: If you’re using this connection to apply data access policies through pushdown or proxy services, you cannot use the Secret Vault configuration option. For information about how to configure and use a secrets manager, see "Secrets manager configuration" in the Administrator help.
Runtime Environment	The name of the runtime environment where you want to run tasks. Specify a Secure Agent, Hosted Agent, or elastic runtime environment. For more information about runtime environments, see Runtime Environments in the Administrator help.

Authentication types

You can configure the OAuth 2.0 authorization code or OAuth 2.0 client credentials authentication types to access Xero.

Select the required authentication type, and then configure the authentication-specific parameters.

OAuth 2.0 authorization code authentication

Configure authentication properties in the Xero connection to use OAuth 2.0 authorization code authentication.

The following table describes the connection properties for OAuth 2.0 authorization code authentication:

Property	Description
Authorization URL	The authorization server endpoint from where you retrieve the authorization code. The authorization URL is https://login.xero.com/identity/connect/authorize
Access Token URL	The Xero access token URL required to exchange the authorization code for an access token. The access token URL is https://identity.xero.com/connect/token
Client ID	The client identifier issued to the client during the application registration process.
Client Secret	The client secret key issued to the client during the application registration process.
Scope	The scope of the access request. To add multiple scopes, separate each scope with a space. For example: accounting.budgets.read accounting.settings.read accounting.contacts.read
Access Token	The access token granted by Xero to access data. Click Generate Token to populate the access token. Note: Do not manually enter the access token. If you manually enter the access token, the connection fails when the access token expires.

OAuth 2.0 client credentials authentication

Configure authentication properties in the Xero connection to use OAuth 2.0 client credentials authentication.

The following table describes the connection properties for OAuth 2.0 client credentials authentication:

Property	Description
Access Token URL	The Xero access token URL required to exchange the client credentials for an access token. The access token URL is https://identity.xero.com/connect/token
Client ID	The client identifier issued to the client during the application registration process.
Client Secret	The client secret key issued to the client during the application registration process.
Scope	The scope of the access request. To add multiple scopes, separate each scope with a space. For example: accounting.budgets.read accounting.settings.read accounting.contacts.read
Access Token	The access token granted by Xero to access data. Click Generate Token to populate the access token. Note: Do not manually enter the access token. If you manually enter the access token, the connection fails when the access token expires.