> For the complete documentation index, see [llms.txt](https://documentation.immuta.com/saas/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.immuta.com/saas/configuration/integrations/teradata/register-a-teradata-connection.md). # Register a Teradata Connection Register your Teradata data and map your user accounts into Immuta {% hint style="info" %} **Public preview**: This integration is available to all accounts that request to enable it for their tenant. Contact your Immuta representative to enable it. {% endhint %} ## Requirement * Teradata VantageCloud or Teradata VantageCore ### Permissions The user registering the connection must have the permissions below. * `APPLICATION_ADMIN` Immuta permission * The Teradata user registering the connection must have access to the user `DBADMIN` * The Teradata user running the setup script must have the permission `CREATE DATABASE` ## Create the database user 1. ​[Create a new user in Teradata to serve as the Immuta system account](https://docs.teradata.com/r/Enterprise_IntelliFlex_VMware/Database-Administration/Working-with-Users-Roles-and-Profiles-Operational-DBAs/Working-with-Database-Users/Creating-Users). Immuta will use this system account continuously to crawl the connection. 2. ​[Grant this account the following Teradata privileges](https://docs.teradata.com/r/Enterprise_IntelliFlex_VMware/Database-Administration/Working-with-Users-Roles-and-Profiles-Operational-DBAs/Granting-Privileges-Directly-To-Users): 1. `SELECT` on the DBC database 2. `CREATE ROLE` 3. `DROP ROLE` 4. `SELECT WITH GRANT OPTION` on all Teradata views and databases that Immuta should manage permissions to 5. `CREATE VIEW WITH GRANT OPTION` 6. `DROP VIEW WITH GRANT OPTION` ## Configure Teradata If your base tables are in a different database than your views, then you must grant your view database the ability to select from your base table database. ```sql GRANT SELECT ON base_table_database TO view_database WITH GRANT OPTION; ``` ## Register a Teradata connection 1. In Immuta, click :database: **Data** and select **Connections** in the navigation menu. 2. Click the **+ Add Connection** button. 3. Select the **Teradata** tile. 4. Enter the host connection information: 1. **Display Name:** This is the name of your new connection. This name will be used in the API (`connectionKey`), in data source names from the host, and on the connections page. Avoid the use of periods (`.`) or [restricted words](#user-content-fn-1)[^1] in your connection name. 2. **Hostname**: Your Teradata host (e.g., `your-host.env.teradata.com` ). 3. **Port**: Port configured for Teradata. 4. **SSL Mode**: Use the dropdown to select your SSL mode. 5. **SSL Protocol**: Based on your SSL mode selection, also select the protocol. 5. Select the authentication method from the dropdown:
Username and Password Enter the **username** and **password** of the [Teradata user you created above](#create-the-database-user).
LDAP Enter the **username** and **password** of the [Teradata user you created above](#create-the-database-user).
OAuth Enter the authentication details of the [Teradata user you created above](#create-the-database-user). 1. Fill out the **Client ID**, which is the subject of the generated token. It is also known as `sub` (subject). 2. Fill out the **Client Secret**. 3. Fill out the **Authority URL** of your identity provider. 4. Enter the **Scope** to limit the operations and roles allowed in Teradata by the access token. See the [OAuth 2.0 documentation](https://oauth.net/2/scope/) for details about scopes.
6. Click **Next**. 1. Opt to **Enable Object Sync**, which will keep your connection objects up to date with your Teradata environment. 1. Select the **Start Time** for when the first object sync job will run each day. 2. Select the **Run Frequency** to determine how frequently object sync will run each day. 3. Opt to **Run Object Sync on Create** to create all the data objects for your connection. If you do not select this option, you must run object sync manually or wait for the scheduled object sync for your connection's data objects. 7. Click **Save connection**. 8. Copy the provided script and run it in Teradata as a user with the privileges [listed in the requirements section](#requirement). Running this script grants the privileges to the Immuta system account. 9. Click **Validate Connection**. 10. If the connection is successful, click **Finish**. If there are any errors, check the connection details and credentials to ensure they are correct and try again. {% hint style="info" %} Teradata does not allow granting `WITH GRANT OPTION` to a role. To ensure all Immuta policies work as expected, the grants to `PUBLIC` on the Immuta tables are required. {% endhint %} ## Grant the `immuta_views` database access After you register the connection and the `immuta_views` database is created, you must grant that database the ability to select from the databases that have your tables and views: ```sql GRANT SELECT ON base_table_database TO immuta_views WITH GRANT OPTION; GRANT SELECT ON view_database TO immuta_views WITH GRANT OPTION; ``` ## Map users **Requirement**: `USER_ADMIN` Immuta permission Map Teradata usernames to each Immuta user account to ensure Immuta properly enforces policies. The instructions below illustrate how to do this for individual users, but you can also configure user mapping in your [IAM connection on the app settings page](/saas/configuration/people/users-index/how-to-guides/external-user-mapping.md#configure-external-user-id-mapping-on-app-settings-page). 1. Click **People** and select **Users** in the navigation menu. 2. Click the user's **name** to navigate to their page and scroll to the **External User Mapping** section. 3. Click **Edit** in the **Teradata User** row. 4. Select the **User Type** from the dropdown: 1. **Teradata Username**: Enter the user's Teradata username. 2. **Unset (fallback to Immuta username)**: When selecting this option, the Teradata username is assumed to be the same as the Immuta username. 3. **None (user does not exist in Teradata)**: Select this option if this is an Immuta-only user. This option will improve performance for Immuta users who do not have a mapping to Teradata users and will be automatically selected by Immuta if an Immuta user is not found in Teradata. To ensure your Teradata users have policies correctly applied, manually map their usernames using the first option above. 5. Click **Save**. [^1]: Your display name cannot be any of the following words: `data`, `connection`, `object`, `crawl`, `search`, `settings`, `metadata`, `permission`, `sync`, `bulk`, and `upgrade`. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://documentation.immuta.com/saas/configuration/integrations/teradata/register-a-teradata-connection.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.