> ## Documentation Index
> Fetch the complete documentation index at: https://www.c1.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up ZipHQ connector

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

<Warning>
  **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.
</Warning>

## Capabilities

| Resource | Sync                                                          | Provision                                                     |
| :------- | :------------------------------------------------------------ | :------------------------------------------------------------ |
| Account  | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |                                                               |
| Group    | <Icon icon="square-check" iconType="solid" color="#c937ae" /> | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |

**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:

<Steps>
  <Step>
    Click the gear icon at the top of Zip and select **Company settings**.
  </Step>

  <Step>
    In the Company Settings menu on the left side of the page, click **API**.
  </Step>

  <Step>
    To generate an API key, click **+ Create API key** at the top right-hand corner of the page.
  </Step>

  <Step>
    In the dropdown menu that appears, select **Standard** as type of API key.
  </Step>

  <Step>
    In the **Name** field, enter a user-friendly name, such as `conductorone-api-key`.
  </Step>

  <Step>
    Click **Create** and the **Save API key** token dialog will appear.
  </Step>

  <Step>
    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.
  </Step>
</Steps>

**Done.** Next, move on to the connector configuration instructions.

## Configure the ZipHQ connector

<Warning>
  **To complete this task, you'll need:**

  * The **Connector Administrator** or **Super Administrator** role in C1
  * Access to the set of ZipHQ configuration information gathered by following the instructions above
</Warning>

<Tabs>
  <Tab title="Cloud-hosted">
    **Follow these instructions to use a built-in, no-code connector hosted by C1.**

    <Steps>
      <Step>
        In C1, navigate to **Integrations** > **Connectors** and click **Add connector**.
      </Step>

      <Step>
        Search for **ZipHQ** and click **Add**.
      </Step>

      <Step>
        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 C1)
        * Add the connector to a managed app (select from the list of existing managed apps)
        * Create a new managed app
      </Step>

      <Step>
        Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.
        If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.
      </Step>

      <Step>
        Click **Next**.
      </Step>

      <Step>
        Find the **Settings** area of the page and click **Edit**.
      </Step>

      <Step>
        Enter the configuration information from the previous section.
      </Step>

      <Step>
        Click **Save**.
      </Step>

      <Step>
        The connector's label changes to **Syncing**, followed by **Connected**. You can view the logs to ensure that information is syncing.
      </Step>
    </Steps>

    **Done.** Your ZipHQ connector is now pulling access data into C1.
  </Tab>

  <Tab title="Self-hosted">
    **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 C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

    ### Resources

    * [Official download center](https://dist.conductorone.com/ConductorOne/baton-ziphq): For stable binaries (Windows/Linux/macOS) and container images.

    ### Step 1: Set up a new ZipHQ connector

    <Steps>
      <Step>
        In C1, navigate to **Integrations** > **Connectors** > **Add connector**.
      </Step>

      <Step>
        Search for **Baton** and click **Add**.
      </Step>

      <Step>
        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 C1)
        * Add the connector to a managed app (select from the list of existing managed apps)
        * Create a new managed app
      </Step>

      <Step>
        Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.
        If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.
      </Step>

      <Step>
        Click **Next**.
      </Step>

      <Step>
        In the **Settings** area of the page, click **Edit**.
      </Step>

      <Step>
        Click **Rotate** to generate a new Client ID and Secret.
        Carefully copy and save these credentials. We'll use them in Step 2.
      </Step>
    </Steps>

    ### Step 2: Create Kubernetes configuration files

    Create two Kubernetes manifest files for your ZipHQ connector deployment:

    #### Secrets configuration

    ```yaml theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-ziphq-secrets.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: baton-ziphq-secrets
    type: Opaque
    stringData:
      # C1 credentials
      BATON_CLIENT_ID: <C1 client ID>
      BATON_CLIENT_SECRET: <C1 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 C1 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

    ```yaml expandable theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # 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

    <Steps>
      <Step>
        Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.
      </Step>

      <Step>
        Check that the connector data uploaded correctly. In C1, click **Apps**. 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.
      </Step>
    </Steps>

    **Done.** Your ZipHQ connector is now pulling access data into C1.
  </Tab>
</Tabs>