Configure Access Request Links

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

Access request links for assets

Access request links will automatically work with any asset in Immuta, as they are all populated from connections. 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 for an improved user experience.

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

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

Variable	Description	Examples	Required or optional
fullyQualifiedName string	This is the fully qualified name of the data object in Immuta. For a table it will be formatted like {database}.{schema}.{table}, but it can also be formatted for parent objects like {database}.{schema}.	customer_orders_database.december_schema.my_table tpch.sf1 databricks	Required
requestType string	Dictate if the requester will be making an access request or masking exception request.	data-access masking-exception	Optional
host string	The data platform host. Use to avoid naming conflicts across hosts. technology must be supplied if using host.	immuta-e2-xxx-deployment-name.cloud.databricks.com	Optional
technology string	The technology of the asset.	Databricks	Required if using host
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

Configure the link in your catalog

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

• Alation

• Atlan

• Collibra

• Databricks

• Snowflake

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 asset's description. 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.	data-access masking-exception	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

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.