Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Zendesk credentials

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

A user with System Admin access in Zendesk must perform this task.

Locate the subdomain for your Zendesk account

1. In your Zendesk account, navigate to the Admin page by clicking the gear icon in the left menu bar.

2. Locate your Zendesk subdomain in the top right corner of the page.

   

3. Make a note of your subdomain.

Create an API token

1. Click Go to Admin Center.

   

2. Open Apps and integrations in the navigation bar and click Zendesk API.

3. Click the toggle to enable token access.

4. Click Add API token, then copy and save the newly created token.

5. Click Save.

   

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

Set up a Zendesk cloud-hosted connector

To complete this task, you’ll need:

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

1. In ConductorOne, click Connectors > Add connector.

2. Search for Zendesk and click Add.

3. Choose how to set up the new Zendesk 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. In the Email field, enter the email address associated with your System Admin account in Zendesk.

8. In the Subdomain field, enter the subdomain.

9. Paste the token into the API Token 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 Zendesk connector is now pulling access data into ConductorOne.

Set up a Zendesk cloud-hosted connector using Terraform

As an alternative to the cloud-hosted setup process described above, you can use Terraform to configure the integration between Zendesk and ConductorOne.

See the ConductorOne Zendesk integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.

Set up a Zendesk self-hosted connector

To complete this task, you’ll need:

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

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

2. Search for Baton and click Add.

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

Secrets configuration

# baton-zendesk-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-zendesk-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Zendesk credentials
  BATON_API_TOKEN: <Zendesk API token>
  BATON_EMAIL: <Email address associated with your System Admin account in Zendesk>
  BATON_SUBDOMAIN: <Zendesk subdomain>

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

Deployment configuration

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

Step 3: Deploy the connector

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

   kubectl create namespace baton-zendesk
   

2. Apply the secret configuration:

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

3. Apply the deployment:

   kubectl -n baton-zendesk apply -f baton-zendesk.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-zendesk}
   

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

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