Set up a Xero connector
Capabilities
Resource | Sync | Provision |
---|---|---|
Accounts | ✅ | |
Organizations | ✅ | |
Roles | ✅ |
Available hosting methods
Choose the hosting method that best suits your needs:
Method | Availability | Notes |
---|---|---|
Cloud hosted | A built-in, no-code connector hosted by ConductorOne. | |
Self-hosted | ✅ | The Xero connector, hosted and run in your own environment. |
Due to limitations in Xero’s regional availability for custom integration development, ConductorOne cannot provide a cloud-hosted Xero connector.
Gather Xero credentials
Each setup method requires you to pass in credentials generated in Xero. Gather these credentials before you move on.
A user with the ability to create a Xero app for your organization must perform this task.
Create a Xero web app and generate credentials
Log into
developer.xero.com
and click New app.In the Add a new app form, give the app a name, such as “ConductorOne” and select Web app.
Enter
https://developer.xero.com
in the Company or application URL field.Enter
https://localhost:8080
in the Redirect URI field.Click Create app.
The new app opens. In the navigation panel on the left, click Configuration.
Carefully copy and save the app’s Client ID.
Click Generate a secret.
Carefully copy and save the Client secret.
That’s it! Next, move on to the instructions for your chosen setup method.
Set up a Xero self-hosted connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
- Access to the set of Xero credentials generated by following the instructions above
When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with ConductorOne, automatically syncing and uploading data at regular intervals. This data is immediately available in the ConductorOne UI for access reviews and access requests.
Why use Kubernetes? Kubernetes provides automated deployment, scaling, and management of your connectors. It ensures high availability and reliable operation of your connector services.
Step 1: Configure the Xero connector
In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new Xero connector:
Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
In the Settings area of the page, click Edit.
Click Rotate to generate a new Client ID and Secret.
Carefully copy and save these credentials. We’ll use them in Step 2.
Step 2: Create Kubernetes configuration files
Create two Kubernetes manifest files for your Xero connector deployment:
Secrets configuration
# baton-xero-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
name: baton-xero-secrets
type: Opaque
stringData:
# ConductorOne credentials
BATON_CLIENT_ID: <ConductorOne client ID>
BATON_CLIENT_SECRET: <ConductorOne client secret>
# Xero credentials
BATON_XERO_CLIENT_ID: <Xero app client ID>
BATON_XERO_CLIENT_SECRET: <Xero app client secret>
See the connector’s README or run
--help
to see all available configuration flags and environment variables.
Deployment configuration
# baton-xero.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: baton-xero
labels:
app: baton-xero
spec:
selector:
matchLabels:
app: baton-xero
template:
metadata:
labels:
app: baton-xero
baton: true
baton-app: xero
spec:
containers:
- name: baton-xero
image: ghcr.io/conductorone/baton-xero:latest
args: ["service"]
imagePullPolicy: IfNotPresent
envFrom:
- secretRef:
name: baton-xero-secrets
Step 3: Deploy the connector
Create a namespace in which to run ConductorOne connectors (if desired):
kubectl create namespace baton-xero
Apply the secret configuration:
kubectl -n baton-xero apply -f baton-xero-secrets.yaml
Apply the deployment:
kubectl -n baton-xero apply -f baton-xero.yaml
Step 4: Verify the deployment
Check that the deployment is running:
kubectl -n c1 get pods
View the connector logs:
kubectl -n c1 logs -l app=baton-${baton-xero}
Check that the connector data uploaded correctly. In ConductorOne, click Applications. On the Managed apps tab, locate and click the name of the application you added the Xero connector to. Xero data should be found on the Entitlements and Accounts tabs.
That’s it! Your Xero connector is now pulling access data into ConductorOne.