# Configure Access Request Links

{% hint style="info" %}
**Private preview**: The assets and access request link features are private preview and available to all accounts.
{% endhint %}

Access request links are deep link URLs that can bring users to access requests in the Immuta UI for the exact data they want to access. Add them to your catalogs so that your users can get to the right access request forms quickly and easily.

## Requirement

[Connection registered in Immuta](https://documentation.immuta.com/saas/configuration/integrations/data-and-integrations#registering-a-connection)

## Access request links for assets

Access request links will automatically work with any asset in Immuta, as they are all populated from [connections](https://documentation.immuta.com/saas/configuration/integrations/data-and-integrations/registering-a-connection/reference-guides/connections-overview). Access request links can be configured with any data catalog by adding it to the data asset's description. However, Immuta does have integrations with [select catalogs](#configure-the-link-in-your-catalog) for an improved user experience. The URL can be built using this format or copy the pre-built link to your clipboard by clicking **Request access link** on the asset's details.

The access request links for every asset have the same format:

```
https://app.immutacloud.com/marketplace/request?requestType&host&technology&fullyQualifiedName&accountId
```

<table><thead><tr><th width="192.2578125">Variable</th><th>Description</th><th width="157.30078125">Examples</th><th width="112.1640625">Required or optional</th></tr></thead><tbody><tr><td><strong>fullyQualifiedName</strong> <code>string</code></td><td><p>This is the fully qualified name of the data object in Immuta.</p><p>For a table it will be formatted like <code>{database}.{schema}.{table}</code>, but it can also be formatted for parent objects like <code>{database}.{schema}</code></p></td><td><ul><li><code>customer_orders_database.december_schema.my_table</code></li><li><code>tpch.sf1</code></li><li><code>customer_data</code></li></ul></td><td>Required</td></tr><tr><td><strong>requestType</strong> <code>string</code></td><td>Dictate if the requester will be making an access request or masking exception request.</td><td><ul><li><code>data-access</code></li><li><code>masking-exception</code></li></ul></td><td>Optional</td></tr><tr><td><strong>host</strong> <code>string</code></td><td>The data platform host. Use to avoid naming conflicts across hosts. <code>technology</code> must be supplied if using <code>host</code>.</td><td><code>immuta-e2-xxx-deployment-name.cloud.databricks.com</code></td><td>Optional</td></tr><tr><td><strong>port</strong> <code>string</code></td><td>Use to avoid naming conflicts across hosts. Host must be included if port is included.</td><td><code>443</code></td><td>Optional</td></tr><tr><td><strong>technology</strong> <code>string</code></td><td>The technology of the asset.</td><td><code>Databricks</code></td><td>Required if using <code>host</code></td></tr><tr><td><strong>accountId</strong> <code>string</code></td><td>This account ID is the unique identifier used to find your account when signing into the Request app. Include it in your link so that users will automatically be directed to the correct account.</td><td><code>immuta-prod</code></td><td>Optional</td></tr></tbody></table>

### Request type

Access request links can include a request type (`requestType`); this will ensure the data consumer is taken to the Request access page for the type of request they want to make:

* **Access request**: Access to data objects like tables, schemas, etc. Include the link on the object.
* **Masking exception request**: Unmasked access to a specific column. Include the link on the column.

If your catalog does not have columns as formal objects, you can do one of the following with your access request links:

1. Place two links on the table with the `requestType` set in each:
   1. `requestType=data-access`
   2. `requestType=masking-exception`
2. Omit the `requestType` from the access link. Immuta will then direct the user to the correct access request or ask the user what request they are trying to make.

## Configure the link in your catalog

Click a catalog below for a how-to on configuring the access request links:

* [Alation](https://documentation.immuta.com/saas/request/configure/how-to-guides/configure-access-request-links/alation)
* [Atlan](https://documentation.immuta.com/saas/request/configure/how-to-guides/configure-access-request-links/atlan)
* [Collibra](https://documentation.immuta.com/saas/request/configure/how-to-guides/configure-access-request-links/collibra)
* [Databricks](https://documentation.immuta.com/saas/request/configure/how-to-guides/configure-access-request-links/databricks-unity-catalog)
* [Snowflake](https://documentation.immuta.com/saas/request/configure/how-to-guides/configure-access-request-links/snowflake-horizon)

If the catalog you want to use is not listed here, you can add the URL to the asset description or annotate the asset metadata. The link is completely deterministic, which means you are able to add it to your catalogs without having to refer to Immuta for any information at all.

## Access request links for data products

Access request links will automatically work with any data product created in Immuta. Access request links can be configured with any data catalog by adding one to the data product's description. However, Immuta does have integrations with [select catalogs](#configure-the-link-in-your-catalog) for an improved user experience. The URL can be built using this format or copy the pre-built link to your clipboard by clicking **Request access link** on the data product's details tab.

The access request links for every data product has the same format:

```
https://app.immutacloud.com/marketplace/data-product/{dataProduct}/request-access?type={requestType}?accountId={accountId}
```

| Variable                 | Description                                                                                                                                                                                                                                                             | Example                                                                           | Required |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -------- |
| **dataProduct** `string` | This can be either the data product name or the data product ID for the specific data product. The data product ID can be found by examining the data product details page's URL here: `https://app.immutacloud.com/marketplace/data-product/{data product id}/details` | `Finance Bundle 2023`                                                             | Required |
| **requestType** `string` | Dictate if the requester will be making an access request or masking exception request.                                                                                                                                                                                 | <ul><li><code>data-access</code></li><li><code>masking-exception</code></li></ul> | Optional |
| **accountId** `string`   | This account ID is the unique identifier used to find your account when signing into the Request app. Include it in your link so that users will automatically be directed to the correct account.                                                                      | `immuta-prod`                                                                     | Optional |

{% hint style="info" %}
When publishing a data product you can customize the data product ID as any valid UUID. This allows you to create data products in Immuta with an ID that matches the ID in your catalog, which is a more resilient redirect method than using the data product name in redirect links.
{% endhint %}

### Resilient data product mirroring

When configuring the access request link in your catalog, use the data product ID rather than the data product name. This way if the name changes, you do not have to make any updates in Immuta or your catalog to ensure the link still works.

In Collibra and Atlan, the request access button is automatically generated using the data product ID in each catalog. In order to ensure the Immuta data product ID matches the catalog data product ID, specify the data product ID when [publishing the data product in Immuta](https://documentation.immuta.com/saas/request/configure/manage-data-products#publishing-a-data-product). This allows you to copy the data product ID from Atlan or Collibra and reuse it when creating the mirrored data product in Immuta. Immuta requires the data product is in valid UUID format, but both Atlan and Collibra's data product IDs conform to Immuta's requirements.


---

# Agent Instructions: 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:

```
GET https://documentation.immuta.com/saas/request/configure/how-to-guides/configure-access-request-links.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.