Set up a Freshservice connector

Capabilities

Resource	Sync	Provision
Accounts
Groups
Roles
Requester groups

This connector can also be configured to automatically create and update Freshservice tickets to track manual provisioning assignments. Go to Configure Freshservice as an external ticketing provider to learn more.

Gather Freshservice credentials

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

A user assigned the IT Agent role and an admin role in Freshservice with the following permissions must complete this task:

Manage Team Dashboards
View Agents and Agent groups
- Edit Agents and Agent groups
- Delete Agents and Agent groups
View roles
View Requesters
- Export Requesters
- Edit Requesters
- Assume Requester Identity
- Delete Requesters

Look up your Freshservice API key

Before you begin, make sure your Freshservice user has all the role permissions listed above.

Log into your Freshservice Support Portal.

Click on your profile picture and select Profile settings.

Your API key is shown in the Delegate Approvals section at the right of the page.If your API key is not shown, an admin user can enable it in Admin Settings > User Management > Agents.

Carefully and copy and save the API key.

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

Configure the Freshservice connector

To complete this task, you’ll need:

The Connector Administrator or Super Administrator role in ConductorOne
Access to the set of Freshservice credentials generated by following the instructions above

Cloud-hosted
Self-hosted

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 Freshservice and click Add.

Choose how to set up the new Freshservice 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 Freshservice subdomain into the Domain field.A subdomain is the example section of https://example.freshservice.com.

Optional. If you want to automatically create Freshservice tickets to track provisioning tasks, click to Enable external ticket processing. Learn more about external ticketing system integrations.

Paste the API key into the API key field.

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 Freshservice connector is now pulling access data into ConductorOne.

Follow these instructions to use the Freshservice 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 Freshservice connector

In ConductorOne, navigate to Connectors > Add connector.

Search for Baton and click Add.

Choose how to set up the new Freshservice 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

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 Freshservice connector deployment:

Secrets configuration

# baton-freshservice-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-freshservice-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Freshservice credentials
  BATON_API_KEY: <Freshservice API key>
  BATON_DOMAIN: <The subdomain for your Freshservice account (such as "example" from https://example.freshservice.com)>

  # Optional: include if you want ConductorOne to provision access using this connector
  BATON_PROVISIONING: true

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

Deployment configuration

# baton-freshservice.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-freshservice
  labels:
    app: baton-freshservice
spec:
  selector:
    matchLabels:
      app: baton-freshservice
  template:
    metadata:
      labels:
        app: baton-freshservice
        baton: true
        baton-app: freshservice
    spec:
      containers:
      - name: baton-freshservice
        image: ghcr.io/conductorone/baton-freshservice:latest
        imagePullPolicy: IfNotPresent
        env:
        - name: BATON_HOST_ID
          value: baton-freshservice
        envFrom:
        - secretRef:
            name: baton-freshservice-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 Freshservice connector to. Freshservice data should be found on the Entitlements and Accounts tabs.

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

Welcome

Build connectors

Configure connectors

Deploy connectors

Upload connector data

Connector library

Set up a Freshservice connector

Capabilities

Gather Freshservice credentials

Look up your Freshservice API key

Configure the Freshservice connector

Step 1: Set up a new Freshservice connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector

Welcome

Build connectors

Configure connectors

Deploy connectors

Upload connector data

Connector library

​Capabilities

​Gather Freshservice credentials

​Look up your Freshservice API key

​Configure the Freshservice connector

​Step 1: Set up a new Freshservice connector

​Step 2: Create Kubernetes configuration files

​Secrets configuration

​Deployment configuration

​Step 3: Deploy the connector

Capabilities

Gather Freshservice credentials

Look up your Freshservice API key

Configure the Freshservice connector

Step 1: Set up a new Freshservice connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector