> ## Documentation Index
> Fetch the complete documentation index at: https://help.dsalta.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse

> Cloud database — members & access

<Tabs>
  <Tab title="Overview">
    Connect ClickHouse Cloud with an API Key ID and Secret to sync organization members and run access reviews. Read-only; the key is held by Nango.

    <Info>
      **Read-only access.** DSALTA only reads data from this integration. It never creates, modifies, or deletes anything in your environment, and every remediation step is performed by your team directly in the third-party product.
    </Info>

    <Note>
      DSALTA collects this integration's data when you connect it — you can refresh it at any time with **Sync from integrations** on the **Integrations** page. The compliance checks below re-run once a day at 02:00 America/New\_York.
    </Note>

    ## What DSALTA reads

    DSALTA reads the ClickHouse user roster — names, emails, roles and join dates, which appears on your **Access** page; and your ClickHouse resources, which appear on your **Inventory** page. The organization members endpoint returns only accepted, current members and publishes no status field, so every member is listed as Active.

    It calls these ClickHouse endpoints:

    * `/v1/organizations`
    * `/v1/organizations/{orgId}/members`
    * `/v1/organizations/{orgId}/services`

    Every request is a read. DSALTA has no code path that creates, modifies, or deletes anything in your ClickHouse environment.

    ## Troubleshooting

    <AccordionGroup>
      <Accordion title="How do I check whether the connection is healthy?">
        Open **Integrations** in the DSALTA sidebar, stay on the **Connected** tab, and click **Manage** on the integration's card. Open the **Status** tab: it shows either **Connected and working properly** or **Connection issues detected**.

        Use the **Status** tab, not **Overview** — Overview always reports **Connected** regardless of the real state.
      </Accordion>

      <Accordion title="A check shows Failed and nothing changed on my side">
        On an integration-powered check, **Failed** normally means DSALTA was blocked rather than that you are non-compliant. Open the test, go to **Source Data**, and read the result code: **403** is a missing permission, **428** is a setting DSALTA still needs, **500** is a failure on DSALTA's side.

        A real compliance gap shows **207** and leaves the test looking **Completed**. See [Understanding Test Results](/guides/data-library/test-results).
      </Accordion>

      <Accordion title="Data looks out of date">
        Compliance checks re-run once a day at 02:00 America/New\_York. To refresh sooner, open **Integrations → Connected** and click **Sync from integrations** at the top right — it refreshes every connected integration at once.
      </Accordion>

      <Accordion title="How do I repair a broken connection?">
        There is no Reconnect, Repair or Refresh Token button. The only repair available is to disconnect and connect again.

        <Warning>
          **Disconnecting is destructive and cannot be undone.** DSALTA removes the access records, inventory, vulnerabilities, code changes, incidents and device records collected from this integration, and deletes the test results tied to the connection. Export anything you still need as audit evidence first — see [Integration errors](/troubleshooting/integration-errors).
        </Warning>
      </Accordion>

      <Accordion title="Configure scope will not let me change anything">
        That is expected. **Configure scope** is read-only — it shows what DSALTA is permitted to read, and has no Save action. To change what DSALTA can see, change the permissions on the credential in the third-party product, then disconnect and connect again.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="How to connect">
    **Before you begin**

    * A ClickHouse Cloud organization. This integration talks to the ClickHouse Cloud control-plane API (`/v1/organizations`); a self-managed or open-source ClickHouse deployment has no such API and cannot be connected.

    <Steps>
      <Step title="Start in DSALTA">
        Open **Integrations** in the DSALTA sidebar, find **ClickHouse**, and click **Connect** to open the connect panel.
      </Step>

      <Step title="Open ClickHouse Cloud API Keys">
        In the ClickHouse Cloud console, go to your organization's Settings, then API Keys.

        <img src="https://mintcdn.com/dsalta/4UzgskHSsjeDN5e5/images/integrations/clickhouse/01-api-keys.png?fit=max&auto=format&n=4UzgskHSsjeDN5e5&q=85&s=adda5d3b44361c0a26cf50feb24c1933" alt="ClickHouse Cloud organization settings with API keys selected and the New API key button" style={{maxWidth:"720px",width:"100%",borderRadius:"8px"}} width="1100" height="521" data-path="images/integrations/clickhouse/01-api-keys.png" />
      </Step>

      <Step title="Create an API key with the Admin role">
        Click New API key and choose the Admin role — a Developer-role key is scoped to specific services only and can't reliably list organization members. Set an expiration if prompted.

        <Tip>This key only reaches ClickHouse Cloud's management API — the console says so on the same page: "Does not include data access." It cannot read, query or export the data held in your services, only organization and service metadata.</Tip>
      </Step>

      <Step title="Copy your Key ID and Key Secret">
        Both are shown once — copy them now. You'll paste the Key ID as the username and the Key Secret as the password in the next step.

        <Tip>If you set an expiration on the key, the connection dies on that date: the daily ClickHouse checks fail and Manage → Status reads Connection issues detected. There is no Reconnect button — the only repair is Disconnect and connect again with a new key, which permanently deletes the ClickHouse access records, inventory and test results already collected.</Tip>
      </Step>

      <Step title="Finish in DSALTA">
        Return to the connect panel you opened in step 1, enter the credential you just created, and confirm to complete the connection.

        <img src="https://mintcdn.com/dsalta/4UzgskHSsjeDN5e5/images/integrations/clickhouse/02-connect-panel.png?fit=max&auto=format&n=4UzgskHSsjeDN5e5&q=85&s=254699f07412103e6a767ab1ae80953e" alt="DSALTA's Link ClickHouse account panel with Key ID and Key Secret fields" style={{maxWidth:"340px",width:"100%",borderRadius:"8px"}} width="996" height="1252" data-path="images/integrations/clickhouse/02-connect-panel.png" />
      </Step>
    </Steps>

    <Check>
      Once connected, ClickHouse appears on the **Connected** tab and the checks below begin reporting after the first sync.
    </Check>
  </Tab>

  <Tab title="Automated checks">
    Each check below re-runs once a day, at 02:00 America/New\_York, while this integration is connected. Click any check for step-by-step remediation guidance.

    | Check                                                                                                                     | Severity | What it verifies                                                                      |
    | ------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------- |
    | [User access to Critical System should be valid](/integrations/clickhouse/user-access-to-critical-system-should-be-valid) | Info     | Checks that everyone with ClickHouse access is an active employee on the People page. |
    | [Offboarded users should not have active access](/integrations/clickhouse/offboarded-users-should-not-have-active-access) | High     | Checks that offboarded employees no longer have active ClickHouse access.             |
  </Tab>

  <Tab title="Useful links">
    | Topic   | Link                                                                                         |
    | ------- | -------------------------------------------------------------------------------------------- |
    | Setup   | [ClickHouse Cloud API — creating API keys](https://clickhouse.com/docs/cloud/manage/openapi) |
    | General | [ClickHouse website](https://clickhouse.com)                                                 |
    | DSALTA  | [Connection error messages](/troubleshooting/connection-error-messages)                      |
  </Tab>
</Tabs>