> ## 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 a Valimail connector

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

## Availability

This connector is compatible with Valimail plans that includes access to the API. API access is standard on the Enforce Enterprise package, and can be included as an add-on for other packages.

## Capabilities

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

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

This connector does not support full account deprovisioning. You can disable accounts using a connector action, but you must deprovision accounts directly in ValiMail.

### 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) | Enables a user's access to ValiMail (activates the account)    |
| disable\_user | `user_id` (string, required) | Disables a user's access to ValiMail (deactivates the account) |

## Gather Valimail configuration information

Each setup method requires you to pass in credentials generated in Valimail. Gather these credentials before you move on.

<Warning>
  A user who is an **Owner** in Valimail must perform this task.

  Additionally, Single Sign-On (SSO) or Multi-Factor Authentication (MFA) must be enabled on the Valimail user's account in order to create an API key.
</Warning>

### Generate an API key

<Steps>
  <Step>
    In Valimail, navigate to **Account Settings** > **API Keys**.
  </Step>

  <Step>
    Create new credentials with the type "Configuration Only".

    This type provides the necessary SCIM API access with the following permissions, which are needed for sync and provisioning operations:

    * Read: Access to the SCIM Users endpoint (`GET /accounts/{slug}/scim/v2/Users`)
    * Write: Ability to create users (`POST /accounts/{slug}/scim/v2/Users`)
    * Update: Ability to modify user attributes including status and member type (`PATCH /accounts/{slug}/scim/v2/Users/{id}`)
  </Step>

  <Step>
    Once the new API ket is created, carefully copy and save the **Client ID** and **App ID**.
  </Step>
</Steps>

### Look up your account slug

The Account Slug can be found in your ValiMail application URL between `/app/` and the next `/`.

For example, if your ValiMail URL is `https://app.valimail.com/app/conductorone-test/sample/overview`, your account slug is `conductorone-test`.

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

## Configure the Valimail connector

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

  * The **Connector Administrator** or **Super Administrator** role in C1
  * Access to the set of Valimail 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 **Valimail** and click **Add**.
      </Step>

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

  <Tab title="Self-hosted">
    **Follow these instructions to use the Valimail 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-valimail): For stable binaries (Windows/Linux/macOS) and container images.

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

    #### Secrets configuration

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

      # Valimail credentials
      BATON_VALIMAIL_APP_ID: <Valimail app ID>
      BATON_VALIMAIL_CLIENT_ID: <Valimail client ID>
      BATON_VALIMAIL_SLUG: <Valimail account slug>

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

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