Set up ZipHQ connector

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

This connector is in beta. This means it’s undergoing ongoing testing and development while we gather feedback, validate functionality, and improve stability. Beta connectors are generally stable, but they may have limited feature support, incomplete error handling, or occasional issues.
We recommend closely monitoring workflows that use this connector and contacting our Support team with any issues or feedback.

Capabilities

Resource	Sync	Provision
Account	✅
Group	✅	✅

Additional functionality:

None.

Gather ZipHQ configuration information

Configuring the connector requires you to pass in information from ZipHQ. Gather these configuration details before you move on.

Here’s the information you’ll need:

API Key
Base URL

To generate an API key in ZipHQ:

Click the gear icon at the top of Zip and select Company settings.
In the Company Settings menu on the left side of the page, click API.
To generate an API key, click + Create API key at the top right-hand corner of the page.
In the dropdown menu that appears, select Standard as type of API key.
In the Name field, enter a user-friendly name, such as conductorone-api-key.
Click Create and the Save API key token dialog will appear.
Click the copy button to the right of the displayed token to copy it to your clipboard, and the paste it in a secure location.

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

Configure the ZipHQ connector

To complete this task, you’ll need:
The Connector Administrator or Super Administrator role in ConductorOne
Access to the set of ZipHQ configuration information gathered 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 ZipHQ and click Add.
Choose how to set up the new ZipHQ 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.
Enter the configuration information from the previous section.
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 ZipHQ connector is now pulling access data into ConductorOne.

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

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

Secrets configuration

# baton-ziphq-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-ziphq-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>

  # ZipHQ config
  BATON_BATON_ZIPHQ_API_KEY: <The API key for authenticating with ZipHQ>
  BATON_BATON_ZIPHQ_BASE_URL: <The base URL of the ZipHQ API>

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

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