Configure authentication to Zip

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

This page shows how to configure Zip to enable authentication from Databricks for the Zip connector. Use the credentials you retrieve from the steps on this page to create a Unity Catalog connection in Databricks.

Prerequisites

• A Zip user with administrator permissions or the Manage company API keys Zip permission group, used to create the API key. See Zip: REST API Information: Authentication.
• To ingest the event_logs table: a Zip Premier subscription. To confirm that your subscription includes audit-trail export, contact your Zip CSM. See Zip: Extract Audit Trail Events.

Configure Zip

In this step, you create a Zip API key. For more information, see Zip: REST API Information: Authentication (API Key Creation and Webhooks).

1. Sign in to Zip and click the gear icon at the top of the page, then select Company settings.
2. In the Company Settings menu, under Setup, click API.
3. On the API keys tab, click + Create API key in the upper right corner.
4. Select the key type: Standard (read and write access on all endpoints) or Restricted (per-record-type access). A Restricted key with Read-only access to the record types you ingest is sufficient.
5. In the Name field, enter a descriptive name (for example, Databricks Lakeflow Connect).
6. (Optional) Enter an Expiration date. After this date, Zip rejects the key and the pipeline fails to authenticate.
7. For a Restricted key, select Read-only in the drop-down menu next to each record type you plan to ingest. Zip blocks access to record types you leave blank.
8. Click Create.
9. In the Save API key dialog, copy the key token and store it securely. Zip only shows the full token once.

Use this key token as the API Token when you create the connection.

Next steps

Create a Zip connection in Databricks. See Create a Zip connection.