> ## 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 Metabase connector

> C1 provides identity governance and just-in-time provisioning for Metabase. Integrate your Metabase 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>

## Support

This connector is compatible with Metabase versions 0.49 and newer. Older versions are not supported.

Due to the nature of Metabase's API versioning model, three versions of this connector are currently available for installation:

* Metabase (unversioned)
* Metabase v0.49
* Metabase v0.56

See the docs below for details on the capabilities of each version and instructions on installing your preferred version.

## Capabilities

### Metabase (unversioned)

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

The Metabase connector supports [automatic account provisioning](/product/admin/account-provisioning).

When a new account is created by C1, the account's password will be sent to a [vault](/product/admin/vaults).

The Metabase connector cannot fully deprovision accounts, but it can enable and disable existing accounts.

#### Connector actions

Connector actions are custom capabilities that extend C1 automations with app-specific operations. You can use connector actions in the [Perform connector action](/product/admin/automations-steps-reference#perform-connector-action) automation step.

| Action name   | Additional fields            | Description                                   |
| ------------- | ---------------------------- | --------------------------------------------- |
| enable\_user  | `user_id` (string, required) | Activates a deactivated Metabase user account |
| disable\_user | `user_id` (string, required) | Deactivates a Metabase user account           |

### Metabase v0.49

| Resource | Sync                                                          | Provision                                                     |
| :------- | :------------------------------------------------------------ | :------------------------------------------------------------ |
| Account  | <Icon icon="square-check" iconType="solid" color="#c937ae" /> | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |
| Database | <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" /> |

The Metabase v0.49 connector supports [automatic account provisioning](/product/admin/account-provisioning).

When a new account is created by C1, the account's password will be sent to a [vault](/product/admin/vaults).

The Metabase v0.49 connector cannot fully deprovision accounts, but it can enable and disable existing accounts.

#### Connector actions

Connector actions are custom capabilities that extend C1 automations with app-specific operations. You can use connector actions in the [Perform connector action](/product/admin/automations-steps-reference#perform-connector-action) automation step.

| Action name   | Additional fields            | Description                                   |
| ------------- | ---------------------------- | --------------------------------------------- |
| enable\_user  | `user_id` (string, required) | Activates a deactivated Metabase user account |
| disable\_user | `user_id` (string, required) | Deactivates a Metabase user account           |

### Metabase v0.56

| Resource | Sync                                                          | Provision                                                     |
| :------- | :------------------------------------------------------------ | :------------------------------------------------------------ |
| Account  | <Icon icon="square-check" iconType="solid" color="#c937ae" /> | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |
| Database | <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" /> |

The Metabase v0.56 connector supports [automatic account provisioning](/product/admin/account-provisioning).

When a new account is created by C1, the account's password will be sent to a [vault](/product/admin/vaults).

The Metabase v0.56 connector cannot fully deprovision accounts, but it can enable and disable existing accounts.

#### Connector actions

Connector actions are custom capabilities that extend C1 automations with app-specific operations. You can use connector actions in the [Perform connector action](/product/admin/automations-steps-reference#perform-connector-action) automation step.

| Action name   | Additional fields            | Description                                   |
| ------------- | ---------------------------- | --------------------------------------------- |
| enable\_user  | `user_id` (string, required) | Activates a deactivated Metabase user account |
| disable\_user | `user_id` (string, required) | Deactivates a Metabase user account           |

## Gather Metabase configuration information

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

Here's the information you'll need:

* API Key
* Base URL

See the Metabase docs for information on how to acquire credentials: [View the documentation](https://www.metabase.com/docs/latest/people-and-groups/api-keys#create-an-api-key)

This connector requires the following scopes:

* Query builder and native

<CardGroup>
  <Card title="Learn how to set the scopes" icon="book" horizontal href="https://www.metabase.com/docs/latest/permissions/introduction" />
</CardGroup>

## Configure the Metabase connector

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

  * The **Connector Administrator** or **Super Administrator** role in C1
  * Access to the set of Metabase 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>
        As relevant, search for **Metabase**, **Metabase v0.49** or **Metabase v0.56** and click **Add**.
      </Step>

      <Step>
        Choose how to set up the new Metabase 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 Metabase connector is now pulling access data into C1.
  </Tab>

  <Tab title="Self-hosted">
    **Follow these instructions to use the Metabase 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

    * [GitHub repository](https://github.com/conductorone/baton-metabase): Access the source code, report issues, or contribute to the project.

    ### Step 1: Set up a new Metabase 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 Metabase 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

    Use the relevant files below to create two Kubernetes manifest files for your Metabase connector deployment.

    #### Metabase (unversioned)

    **Secrets configuration**

    ```yaml expandable theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-metabase-secrets.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: baton-metabase-secrets
    type: Opaque
    stringData:
      # C1 credentials
      BATON_CLIENT_ID: <C1 client ID>
      BATON_CLIENT_SECRET: <C1 client secret>

      # Metabase config
      BATON_METABASE_API_KEY: <Metabase API Key>
      BATON_METABASE_BASE_URL: <Metabase Base URL>

      # 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-metabase.yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: baton-metabase
      labels:
        app: baton-metabase
    spec:
      selector:
        matchLabels:
          app: baton-metabase
      template:
        metadata:
          labels:
            app: baton-metabase
            baton: true
            baton-app: metabase
        spec:
          containers:
          - name: baton-metabase
            image: ghcr.io/conductorone/baton-metabase:latest
            imagePullPolicy: IfNotPresent
            env:
            - name: BATON_HOST_ID
              value: baton-metabase
            envFrom:
            - secretRef:
                name: baton-metabase-secrets
    ```

    #### Metabase v0.49

    **Secrets configuration**

    ```yaml expandable theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-metabase-v049-secrets.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: baton-metabase-v049-secrets
    type: Opaque
    stringData:
      # C1 credentials
      BATON_CLIENT_ID: <C1 client ID>
      BATON_CLIENT_SECRET: <C1 client secret>

      # Metabase config
      BATON_METABASE_API_KEY: <Metabase API Key>
      BATON_METABASE_BASE_URL: <Metabase Base URL>

      # 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-metabase-v049.yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: baton-metabase-v049
      labels:
        app: baton-metabase-v049
    spec:
      selector:
        matchLabels:
          app: baton-metabase-v049
      template:
        metadata:
          labels:
            app: baton-metabase-v049
            baton: true
            baton-app: metabase-v049
        spec:
          containers:
          - name: baton-metabase-v049
            image: ghcr.io/conductorone/baton-metabase-v049:latest
            imagePullPolicy: IfNotPresent
            env:
            - name: BATON_HOST_ID
              value: baton-metabase-v049
            envFrom:
            - secretRef:
                name: baton-metabase-v049-secrets
    ```

    #### Metabase v0.56

    **Secrets configuration**

    ```yaml expandable theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-metabase-v056-secrets.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: baton-metabase-v056-secrets
    type: Opaque
    stringData:
      # C1 credentials
      BATON_CLIENT_ID: <C1 client ID>
      BATON_CLIENT_SECRET: <C1 client secret>

      # Metabase config
      BATON_METABASE_API_KEY: <Metabase API Key>
      BATON_METABASE_BASE_URL: <Metabase Base URL>

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

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