Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Freshdesk credentials

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

A user with the permissions to view all user data in Freshdesk must perform this task.

Look up your Freshdesk API key

1. Log in to your account in the Freshdesk Support Portal.

2. Click on your profile picture in the top right corner of the screen and select Profile settings.

3. Click View API key and complete the verification.

4. Carefully copy and save the API key.

Look up your Freshdesk domain

You’ll also need to provide your Freshdesk domain when setting up the connector. The domain is found in the URL of your Freshdesk implementation.

In the sample URL https://example.freshdesk.com, the domain is example.

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

Set up a Freshdesk cloud-hosted connector

To complete this task, you’ll need:

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

1. In ConductorOne, navigate to Admin > Connectors and click Add connector.

2. Search for Freshdesk and click Add.

   Don’t see the Freshdesk connector? Reach out to support@conductorone.com to add Freshdesk to your Connectors page.

1. Choose how to set up the new Freshdesk 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

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

3. Click Next.

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

5. Paste your Freshdesk domain into the Domain field.

   The domain is example in the Freshdesk instance address https://example.freshdesk.com.

6. Paste the API key into the API key field.

7. Click Save.

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

Set up a Freshdesk self-hosted connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in ConductorOne
• Access to the set of Freshdesk 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 Freshdesk connector

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

2. Search for Baton and click Add.

3. Choose how to set up the new Freshdesk 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 Freshdesk connector deployment:

Secrets configuration

# baton-freshdesk-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-freshdesk-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Freshdesk credentials
  BATON_API_KEY: <Freshdesk API key>
  BATON_DOMAIN: <Freshdesk account domain>

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

Deployment configuration

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

Step 3: Deploy the connector

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

   kubectl create namespace conductorone
   

2. Apply the secret configuration:

   kubectl -n conductorone apply -f baton-freshdesk-secrets.yaml
   

3. Apply the deployment:

   kubectl -n conductorone apply -f baton-freshdesk.yaml
   

Step 4: Verify the deployment

1. Check that the deployment is running:

   kubectl -n conductorone get pods
   

2. View the connector logs:

   kubectl -n conductorone logs -l app=baton-${baton-freshdesk}
   

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 Freshdesk connector to. Freshdesk data should be found on the Entitlements and Accounts tabs.

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