Skip to main content

Set up Hightouch

Configure Hightouch roles, groups, and API keys to establish secure access for the Atlan integration.

Prerequisites​

Before you begin, make sure you have:

  • Access to Hightouch as an administrator
  • Permissions to create custom roles, groups, and API keys in Hightouch
  • Ability to provision system accounts in your organization directory

Create custom role​

Create a custom role in Hightouch to grant Atlan the necessary read-only permissions.

  1. Log into Hightouch and navigate to Settings > Roles.

  2. Click Add Role to create a new custom role.

  3. Enter atlan_role as the role name.

  4. Select the JSON Builder option to create the role using JSON policy.

  5. Use the following JSON policy:

    {
      "version": "2022-04-26",
      "policies": [
        {
          "effect": "allow",
          "actions": [
            "read"
          ],
          "resource": [
            "workspace",
            "source",
            "destination",
            "model",
            "sync",
            "sync_templates"
          ]
        }
      ]
    }

  6. Click Add Role to save the custom role.

Create group​

Create a dedicated group for Atlan users in Hightouch.

  1. In Hightouch, navigate to Settings > Groups.

  2. Click Add Group to create a new group.

  3. Enter atlan_group as the group name.

  4. Click Create Group to save the group.

Create user and assign to group​

Create a system account user and assign it to the Atlan group.

  1. Provision a system account in your organization's directory.

  2. Create a Hightouch user account for the system account using SSO or through invites.

  3. Assign the user to the atlan_group you created.

Assign role to group​

Assign the custom role to the group to grant appropriate permissions.

  1. In Hightouch, navigate to Settings > Roles.

  2. Find the atlan_role you created and click on it.

  3. Assign the role to the atlan_group.

Generate API key​

Create an API key for the system account to authenticate with Hightouch.

  1. Log into Hightouch as the system account user.

  2. Navigate to Settings > API Keys.

  3. Click Create API Key.

  4. Enter a descriptive name for the key, such as Atlan Integration.

  5. Copy the generated API key and store it securely.

Next steps​