Set up a FreshBooks connector

ConductorOne provides identity governance and just-in-time provisioning for FreshBooks. Integrate your FreshBooks instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests.

Capabilities

Resource	Sync	Provision
Accounts	✅
Roles	✅

Gather FreshBooks credentials

Configuring the connector requires you to pass in credentials generated in FreshBooks. Gather these credentials before you move on.

A user with access to the FreshBooks Developer site must perform this task.

Create a FreshBooks app

Log into the FreshBooks Developer site.
Navigate to the Apps page and click Create New App.
Fill in the required details and give the new app the user:profile:read scope.
Save the app.
On the Apps page, click the new app’s name. Carefully copy and save the app’s Client ID and Client secret.
Click Go to authentication page.
Click Allow. The application is authorized. Carefully copy and save the authorization code.

Self-hosted only: Generate a refresh token

Run the following curl command, filling in the variables as noted:

curl -X POST https://api.freshbooks.com/auth/oauth/token \
-d 'grant_type=authorization_code' \
-d 'client_id=<58f1...>' \
-d 'client_secret=c4a8...' \
-d 'code=8749...' \
-d 'redirect_uri=https://awesomeonlinestore.example/redirect'

The response will look like this:

{
  "access_token":"eyJra...",
  "token_type":"Bearer",
  "expires_in":43200,
  "refresh_token":"818c...",
  "scope":"user:profile:read user:clients:read user:expenses:read","created_at":1747105792,
  "direct_buy_tokens":{}
}

Carefully copy and save the refresh token.

That’s it! Next, move on to the connector configuration instructions.

Configure the FreshBooks connector

To complete this task, you’ll need:
The Connector Administrator or Super Administrator role in ConductorOne
Access to the set of FreshBooks credentials generated by following the instructions above

Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.

In ConductorOne, navigate to Admin > Connectors and click Add connector.
Search for FreshBooks and click Add.
Choose how to set up the new FreshBooks 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.
Find the Settings area of the page and click Edit.
Paste your FreshBooks credentials into the relevant fields.
Click Login with OAuth and follow the prompts.
After authenticating with FreshBooks, you’ll be redirected back to the connector setup page in ConductorOne, where you’ll see an authorization message.
Click Save.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

That’s it! Your FreshBooks connector is now pulling access data into ConductorOne.

Follow these instructions to use the FreshBooks connector, hosted and run in your own environment.

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.

Step 1: Set up a new FreshBooks connector

In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new FreshBooks 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 FreshBooks connector deployment:

Secrets configuration

# baton-freshbooks-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-freshbooks-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # FreshBooks credentials
  BATON_FB_CLIENT_ID: <FreshBooks client ID>
  BATON_FB_CLIENT_SECRET: <FreshBooks client secret>
  BATON_REFRESH_TOKEN: <FreshBooks refresh token>

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# baton-freshbooks.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-freshbooks
  labels:
    app: baton-freshbooks
spec:
  selector:
    matchLabels:
      app: baton-freshbooks
  template:
    metadata:
      labels:
        app: baton-freshbooks
        baton: true
        baton-app: freshbooks
    spec:
      containers:
      - name: baton-freshbooks
        image: ghcr.io/conductorone/baton-freshbooks:latest
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-freshbooks-secrets

Step 3: Deploy the connector

Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.
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 FreshBooks connector to. FreshBooks data should be found on the Entitlements and Accounts tabs.

That’s it! Your FreshBooks connector is now pulling access data into ConductorOne.