Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Freshservice credentials

Each setup method requires you to pass in credentials generated in Freshservice. Gather these credentials before you move on.

Look up your Freshservice API key

1. Log in to your Freshservice Support Portal.

2. Click on your profile picture and select Profile settings.

3. Your API key is shown in the Delegate Approvals section at the right of the page.

4. Carefully and copy and save the API key.

That’s it! Next, move on to the instructions for your chosen setup method.

Set up a Freshservice cloud-hosted 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

1. In ConductorOne, click Connectors > Add connector.

2. Search for Freshservice and click Add.

3. 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

4. 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.

5. Click Next.

6. Find the Settings area of the page and click Edit.

7. Paste your Freshservice subdomain into the Domain field.

   A subdomain is the example section of https://example.freshservice.com.

8. 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.

9. Paste the API key into the API key field.

10. Click Save.

11. 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.

Set up a Freshservice self-hosted 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

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

1. In ConductorOne, navigate to Connectors > Add connector.

2. Search for Baton and click Add.

3. 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

4. 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.

5. Click Next.

6. In the Settings area of the page, click Edit.

7. 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
        args: ["service"]
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-freshservice-secrets

Step 3: Deploy the connector

1. Create a namespace in which to run ConductorOne connectors (if desired):

   kubectl create namespace baton-freshservice
   

2. Apply the secret configuration:

   kubectl -n baton-freshservice apply -f baton-freshservice-secrets.yaml
   

3. Apply the deployment:

   kubectl -n baton-freshservice apply -f baton-freshservice.yaml
   

Step 4: Verify the deployment

1. Check that the deployment is running:

   kubectl -n c1 get pods
   

2. View the connector logs:

   kubectl -n c1 logs -l app=baton-${baton-freshservice}
   

3. 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.