Manage Data Products
Data product managers are able to publish and manage data products.
Requirement: Immuta permission GOVERNANCE or Manage Data Product in a domain
Publishing a data product
With the UI
Click Publish product.
Select the Domain from the dropdown. You will only be able to include data source from this domain in your data product. If you do not see a domain available, create one with at least one data source.
Click Next.
Select the data sources you want in the data product. If you do not see a data source you expected to see, it is not in the domain you selected.
Click Next.
Enter the following metadata for your new data product:
Name of the data product
Description of the data product (optional)
Enter the subject matter expert (optional). This should be a user that data consumers and stewards can reach out to for any questions about the data product.
Click Next.
Using the dropdown, select a request form or scroll down to Create new +. Any data consumer requesting access to your data product will need to complete the request form:
Select an existing request form: Review the form details, review flow, and linked products.
Create new:
Enter the form name, which is how other data product owners can add it to their own data product.
Enter one or more request questions for the data consumer to answer:
Enter a question and select the answer format in the dropdown.
Use the switch to dictate if the question is required.
Click the + icon to add more questions.
Navigate to the Review flow tab.
Choose if you would like to require approval for access to this data product:
Yes: When the user requests access, in addition to acknowledging the data use agreement and answering the required question, they will need to be approved by one of the data stewards.
Choose the Immuta source from the dropdowns that will dictate who is a data steward. If you include multiple sources, only one is required to allow the data steward to approve access. If you select a domain permission, the data steward must have that domain-specific permission for the domain the data product is built off of.
No: When the user requests access, they will be automatically approved once they acknowledge the data use agreement and answer any question required for access. Enter the reason users do not need approval.
Add a data use agreement (optional). Use the default data use agreement or Create new +. The data use agreement is what the data consumer must agree to when requesting access to your data product.
Click Publish data product.
With the API
Ensure you set the correct global segment and use a Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.
There is a short term limitation with the Marketplace app where adding data sources to a data product with active subscription policies set to Always Require could result in currently subscribed users losing access.
Editing data products
Once a data product has been published, many components can be edited from different parts of the data product:
Details: Edit the name, description, or subject matter expert
Data sources: Add or remove data sources from the data product
Request form: Edit the request form assigned to the data product
With the UI
Select the data product.
Navigate to the tab with the information you want to edit.
Click Edit.
Make your edits and click Save.
With the API
Ensure you set the correct global segment and use a Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.
Update the request settings
To update the request settings of a data product:
Run
POST /api/request-from: Use the ID from the response in the next call.Run
PUT/api/data-product/{id}: The{id}in the request should be the data product ID and the request form ID from the previous call should be included in the payload.
Update the data sources
Ensure you set the correct global segment and use a Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.
To update data sources associated with a data product:
Suspend access to data products
Data products can be suspended. Suspending access revokes all access to data sources in the data product that was gained from the manual approvals in the Marketplace. However, the data product access can be resumed to grant the approvals again.
With the UI
Select the data product.
Navigate to the Settings tab.
Select Suspend access and then click Suspend access on the modal.
With the API
Ensure you set the correct global segment and use a Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.
Update the suspended parameter using the endpoint below:
Deleting data products
It is also possible to delete data products, which will remove all users' access to the data sources within the data product. Deleting a data product cannot be undone.
With the UI
Select the data product.
Navigate to the Settings tab.
Click Delete data product.
Enter the name of your data product in the textbox and then click Delete again.
With the API
Ensure you set the correct global segment and use a Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.
Last updated
Was this helpful?