# Manage Data Products

Data product managers are able to publish and manage [data products](https://documentation.immuta.com/SaaS/request/access-data-products/reference-guide/data-products-and-assets).

**Requirement**: Immuta permission `GOVERNANCE` or `Manage Data Products` in a domain

## Hide data products from consumers

{% hint style="info" %}
This option is available if you have the [assets feature](https://documentation.immuta.com/SaaS/access-data-products/reference-guide/data-products-and-assets#assets) on your tenant. Reach out to your Immuta representative if you would like to enable this feature.
{% endhint %}

Hiding data products from your data consumers in the Request app will only allow them to access data products through links, [which can be added to your data catalog](https://documentation.immuta.com/SaaS/request/configure/how-to-guides/configure-access-request-links). To hide data products from your consumers,

1. Navigate to the <i class="fa-gear">:gear:</i> [**Application page**](https://app.immutacloud.com/marketplace/settings/application).
2. Flip the **Allow Consumers to discover data products** toggle to off.

## Publishing a data product

### With the UI

1. From the [**Data products** page](https://app.immutacloud.com/marketplace/data-products), click **Publish product**.
2. Select the **Domain** from the dropdown. You will only be able to include data sources from this domain in your data product. [If you do not see a domain available, create one with at least one data source](https://documentation.immuta.com/SaaS/request/reference-guides/walkthrough#governance-and-user-admin-users).
3. Click **Next**.
4. 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](https://documentation.immuta.com/SaaS/request/reference-guides/walkthrough#making-data-sources-available-to-a-domain).
5. Click **Next**.
6. Enter the following metadata for your new data product:
   * Name of the data product
   * Data product ID (optional). Enter a data product ID to ensure the ID in Immuta matches the ID from your catalog in order to [set up access requests from your catalog](https://documentation.immuta.com/SaaS/request/configure/configure-access-request-links#access-request-links-for-data-products).
   * 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.
7. Click **Next**.
8. Using the dropdown, select a request form or scroll down to **Create new +**. Any data consumer requesting access or making a masking exception request to your data product will need to complete the same request form:
   1. **Select an existing request form**: Review the form details, review flow, data use agreement, and linked products.
   2. **Create new**: This will create a new request form that will be used for this data product and can be used in data products published in the future.
      1. Enter the form name, which is how other data product owners can add the request form to their own data product.
      2. Enter one or more request questions for the data consumer to answer:
         1. Enter a question and select the answer format in the dropdown.
         2. Use the switch to dictate if the question is required.
         3. Click the **+** icon to add more questions.
      3. Select how you want the review flow determined:
         1. **Delegate**: Data products and assets that use this form will configure their own review flow.
         2. **In this request form**: The review flow defined here will apply to all assigned data products.
            1. Choose if you would like to require approval for requests on this data product:
               * **Yes**: When the user makes a request on a data product, in addition to acknowledging the data use agreement and answering the required question, they will need to be approved by the data stewards.
                 * Assign the data stewards: Choose the Immuta source from the dropdowns that will dictate who is a data steward. If you select a domain permission, the data steward must have that domain-specific permission for the domain that the data product is built off of.
                 * Choose if you would like to require all or any data stewards to approve:
                   * **All stewards**: For every source you select, a data steward from that source must make a determination. If a data steward qualifies multiple sources, their determination will count for each of the sources they have. If any of the data stewards deny the request, it will be denied. If any of the data stewards temporarily approve the request, once the determination is made, the user will be approved for temporary access for the shortest time period given.
                   * **Any steward**: A single determination is required for the request, and any data steward with any of the sources dictated can make the determination.
               * **No**: When the user makes a request on a data product, they will be automatically approved once they acknowledge the data use agreement and answer any question required for access:
                 * **Auto approve:** Enter the reason users do not need approval.
                 * **Auto approve with expiration**: Enter the reason users do not need approval and use the dropdown to select how long users will have access to the data before the access expires.
      4. 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 or a masking exception to your data product.
9. Click **Next**.
10. If your request form has the review flow set to **Delegate** you must set your data stewards:
    1. Choose if you would like to require approval for requests on this data product:
       * **Yes**: When the user makes a request on a data product, in addition to acknowledging the data use agreement and answering the required question, they will need to be approved by the data stewards.
         * Assign the data stewards: Choose the Immuta source from the dropdowns that will dictate who is a data steward. If you select a domain permission, the data steward must have that domain-specific permission for the domain that the data product is built off of.
         * Choose if you would like to require all or any data stewards to approve:
           * **All stewards**: For every source you select, a data steward from that source must make a determination. If a data steward qualifies multiple sources, their determination will count for each of the sources they have. If any of the data stewards deny the request, it will be denied. If any of the data stewards temporarily approve the request, once the determination is made, the user will be approved for temporary access for the shortest time period given.
           * **Any steward**: A single determination is required for the request, and any data steward with any of the sources dictated can make the determination.
       * **No**: When the user makes a request on a data product, they will be automatically approved once they acknowledge the data use agreement and answer any question required for access:
         * **Auto approve:** Enter the reason users do not need approval.
         * **Auto approve with expiration**: Enter the reason users do not need approval and use the dropdown to select how long users will have access to the data before the access expires.
11. Click **Publish data product**.

### With the API

Ensure you set the [correct global segment](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#base-path-and-global-segment) and use a [Request app personal access token (PAT)](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#generate-a-personal-access-token-pat) when using the Request app API. See the [Request app API docs](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api) for additional guidance or to download the OpenAPI YAML for your own client generation.

## Add new data products to the marketplace

> Add one or more data products to the marketplace

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Data Product","description":"APIs for managing data products"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateDataProduct":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"},"description":{"oneOf":[{"type":"string","description":"Data product description"}],"nullable":true,"description":"Data product description"},"metadata":{"oneOf":[{"type":"object","properties":{"subjectMatterExpert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Immuta global user ID of the subject matter expert for this data product"},"username":{"type":"string"},"name":{"type":"string"}},"required":["id"]}},"required":["subjectMatterExpert"]}],"nullable":true},"domains":{"type":"array","items":{"type":"string"},"minItems":1},"dataAccessPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product data access policy","title":"Data Product Data Access Policy"},"maskingExceptionPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product masking exception policy","title":"Data Product Masking Exception Policy"},"id":{"type":"string","format":"uuid","description":"Data product ID"},"dataSources":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string"}},"required":["sourceId"]}},"requestFormId":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]}},"required":["name","metadata","domains","dataSources","requestFormId"]},"DataProduct":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"},"description":{"oneOf":[{"type":"string","description":"Data product description"}],"nullable":true,"description":"Data product description"},"domains":{"type":"array","items":{"type":"string"},"minItems":1},"suspended":{"type":"boolean","description":"Whether access to the data product's data sources is suspended"},"createdBy":{"type":"string","format":"uuid","description":"Immuta global user ID of the user who created the data product"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["APPROVED","CANCELED","DENIED","PENDING","NONE","PUBLISHER","REVOKED","EXPIRED"]},"expiration":{"oneOf":[{"type":"string","format":"date-time"}],"nullable":true},"stats":{"type":"object","properties":{"dataSourceCount":{"type":"integer","description":"Count of data sources in a data product"},"pendingRequestCount":{"type":"integer","description":"Count of pending requests for a data product"},"approvedRequestCount":{"type":"integer","description":"Count of approved requests for a data product"},"revokedRequestCount":{"type":"integer","description":"Count of revoked requests for a data product"},"canceledRequestCount":{"type":"integer","description":"Count of canceled requests for a data product"},"deniedRequestCount":{"type":"integer","description":"Count of denied requests for a data product"},"totalRequestCount":{"type":"integer","description":"Count of total requests for a data product"}},"required":["dataSourceCount","pendingRequestCount","approvedRequestCount","revokedRequestCount","canceledRequestCount","deniedRequestCount","totalRequestCount"],"description":"Data product statistics","title":"Data Product Stats"},"requestId":{"type":"string","format":"cuid","description":"If requested, the ID of the access request for the data product"},"sourceTypes":{"type":"array","items":{"type":"string"},"description":"The types of data sources contained in the data product."},"metadata":{"oneOf":[{"type":"object","properties":{"subjectMatterExpert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Immuta global user ID of the subject matter expert for this data product"},"username":{"type":"string"},"name":{"type":"string"}},"required":["id"]}},"required":["subjectMatterExpert"]}],"nullable":true},"dataAccessPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product data access policy","title":"Data Product Data Access Policy"},"maskingExceptionPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product masking exception policy","title":"Data Product Masking Exception Policy"}},"required":["id","name","domains","suspended","createdBy","createdAt","updatedAt","metadata"]}}},"paths":{"/api/data-product":{"post":{"description":"Add one or more data products to the marketplace","operationId":"createDataProduct","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDataProduct"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProduct"}}}},"409":{"description":"Data Product name in use."}},"summary":"Add new data products to the marketplace","tags":["Data Product"]}}}}
```

## Remove members from data products

To revoke a member's access, you can remove them from the data product.

### With the UI

1. From the [**Data products** page](https://app.immutacloud.com/marketplace/data-products), select the data product and navigate to the **Members** tab.
2. Click the **more actions** icon.
3. Select **Revoke Access**.

### With the API

Ensure you set the [correct global segment](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#base-path-and-global-segment) and use a [Request app personal access token (PAT)](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#generate-a-personal-access-token-pat) when using the Request app API. See the [Request app API docs](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api) for additional guidance or to download the OpenAPI YAML for your own client generation.

## Revoke access to a data product

> Updates the specified access request to revoked and revokes access to data sources associated with the data product

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Data Product","description":"APIs for managing data products"},{"name":"Access Request","description":"APIs for managing data access"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/api/data-product/{id}/request/{requestId}":{"delete":{"description":"Updates the specified access request to revoked and revokes access to data sources associated with the data product","operationId":"revokeAccess","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"requestId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""}},"summary":"Revoke access to a data product","tags":["Data Product","Access Request"]}}}}
```

## 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

{% hint style="info" %}
**Editing a data product name**

If you are updating a data product name and have an integration set up between Immuta and an existing catalog, ensure you update the name of the data product in the deep link and in the data catalog.
{% endhint %}

### With the UI

1. From the [**Data products** page](https://app.immutacloud.com/marketplace/data-products), select the data product.
2. Navigate to the tab with the information you want to edit.
3. Click **Edit**.
4. Make your edits and click **Save**.

### With the API

Ensure you set the [correct global segment](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#base-path-and-global-segment) and use a [Request app personal access token (PAT)](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#generate-a-personal-access-token-pat) when using the Request app API. See the [Request app API docs](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api) for additional guidance or to download the OpenAPI YAML for your own client generation.

#### Update the request form

To update the request form of a data product:

1. Run `POST /api/request-form` to create a new request form: Use the ID from the response in the next call.
2. Run `PUT/api/data-product/{id}` to add the new request form to the data product: 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.

## Create request form

> Create a request form

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateRequestForm":{"type":"object","properties":{"name":{"type":"string"},"fields":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["DROPDOWN","CHECKBOXES"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}}},"required":["id","type","label","options"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["ACCESS_DURATION"]},"label":{"type":"string","enum":["How long do you need access to this data?"]},"required":{"type":"boolean","enum":[true]}},"required":["id","type","label","required"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"id":{"type":"string","format":"uuid"},"dataUseAgreementIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name","fields","policy"]},"RequestForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"fields":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["DROPDOWN","CHECKBOXES"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}}},"required":["id","type","label","options"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["ACCESS_DURATION"]},"label":{"type":"string","enum":["How long do you need access to this data?"]},"required":{"type":"boolean","enum":[true]}},"required":["id","type","label","required"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of data use agreement"},"body":{"type":"string","description":"The contents of data use agreement"}},"required":["id","name","body"]},"title":"Request Form Data Use Agreements"},"createdBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who originally created the request form"},"createdAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"updatedBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who last updated the request form"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"version":{"type":"string","format":"cuid","description":"The current version of the request form"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"}}},"paths":{"/api/request-form":{"post":{"description":"Create a request form","operationId":"createRequestForm","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestForm"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForm"}}}},"409":{"description":"Request form with name already exists."}},"summary":"Create request form","tags":["Request Form"]}}}}
```

## Update an existing data product

> Update an existing data product by ID

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Data Product","description":"APIs for managing data products"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateDataProduct":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"},"description":{"oneOf":[{"type":"string","description":"Data product description"}],"nullable":true,"description":"Data product description"},"metadata":{"oneOf":[{"type":"object","properties":{"subjectMatterExpert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Immuta global user ID of the subject matter expert for this data product"},"username":{"type":"string"},"name":{"type":"string"}},"required":["id"]}},"required":["subjectMatterExpert"]}],"nullable":true},"domains":{"type":"array","items":{"type":"string"},"minItems":1},"dataAccessPolicy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"]},"maskingExceptionPolicy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"]},"id":{"type":"string","format":"uuid","description":"Data product ID"},"dataSources":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string"}},"required":["sourceId"]}},"requestFormId":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]},"suspended":{"type":"boolean","description":"Whether access to the data product's data sources is suspended"}}},"DataProduct":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"},"description":{"oneOf":[{"type":"string","description":"Data product description"}],"nullable":true,"description":"Data product description"},"domains":{"type":"array","items":{"type":"string"},"minItems":1},"suspended":{"type":"boolean","description":"Whether access to the data product's data sources is suspended"},"createdBy":{"type":"string","format":"uuid","description":"Immuta global user ID of the user who created the data product"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["APPROVED","CANCELED","DENIED","PENDING","NONE","PUBLISHER","REVOKED","EXPIRED"]},"expiration":{"oneOf":[{"type":"string","format":"date-time"}],"nullable":true},"stats":{"type":"object","properties":{"dataSourceCount":{"type":"integer","description":"Count of data sources in a data product"},"pendingRequestCount":{"type":"integer","description":"Count of pending requests for a data product"},"approvedRequestCount":{"type":"integer","description":"Count of approved requests for a data product"},"revokedRequestCount":{"type":"integer","description":"Count of revoked requests for a data product"},"canceledRequestCount":{"type":"integer","description":"Count of canceled requests for a data product"},"deniedRequestCount":{"type":"integer","description":"Count of denied requests for a data product"},"totalRequestCount":{"type":"integer","description":"Count of total requests for a data product"}},"required":["dataSourceCount","pendingRequestCount","approvedRequestCount","revokedRequestCount","canceledRequestCount","deniedRequestCount","totalRequestCount"],"description":"Data product statistics","title":"Data Product Stats"},"requestId":{"type":"string","format":"cuid","description":"If requested, the ID of the access request for the data product"},"sourceTypes":{"type":"array","items":{"type":"string"},"description":"The types of data sources contained in the data product."},"metadata":{"oneOf":[{"type":"object","properties":{"subjectMatterExpert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Immuta global user ID of the subject matter expert for this data product"},"username":{"type":"string"},"name":{"type":"string"}},"required":["id"]}},"required":["subjectMatterExpert"]}],"nullable":true},"dataAccessPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product data access policy","title":"Data Product Data Access Policy"},"maskingExceptionPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product masking exception policy","title":"Data Product Masking Exception Policy"}},"required":["id","name","domains","suspended","createdBy","createdAt","updatedAt","metadata"]}}},"paths":{"/api/data-product/{id}":{"put":{"description":"Update an existing data product by ID","operationId":"updateDataProduct","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDataProduct"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProduct"}}}}},"summary":"Update an existing data product","tags":["Data Product"]}}}}
```

#### Update the data sources

Ensure you set the [correct global segment](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#base-path-and-global-segment) and use a [Request app personal access token (PAT)](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#generate-a-personal-access-token-pat) when using the Request app API. See the [Request app API docs](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api) for additional guidance or to download the OpenAPI YAML for your own client generation.

To update data sources associated with a data product:

## Update the data product's data sources

> Update the data sources associated with the data product. Any currently associated data sources not included in the payload will be removed.

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Data Product","description":"APIs for managing data products"},{"name":"Data Source","description":"APIs for managing data sources"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateDataSources":{"type":"object","properties":{"dataSources":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string"}},"required":["sourceId"]}}},"required":["dataSources"]},"DataProduct":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"},"description":{"oneOf":[{"type":"string","description":"Data product description"}],"nullable":true,"description":"Data product description"},"domains":{"type":"array","items":{"type":"string"},"minItems":1},"suspended":{"type":"boolean","description":"Whether access to the data product's data sources is suspended"},"createdBy":{"type":"string","format":"uuid","description":"Immuta global user ID of the user who created the data product"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["APPROVED","CANCELED","DENIED","PENDING","NONE","PUBLISHER","REVOKED","EXPIRED"]},"expiration":{"oneOf":[{"type":"string","format":"date-time"}],"nullable":true},"stats":{"type":"object","properties":{"dataSourceCount":{"type":"integer","description":"Count of data sources in a data product"},"pendingRequestCount":{"type":"integer","description":"Count of pending requests for a data product"},"approvedRequestCount":{"type":"integer","description":"Count of approved requests for a data product"},"revokedRequestCount":{"type":"integer","description":"Count of revoked requests for a data product"},"canceledRequestCount":{"type":"integer","description":"Count of canceled requests for a data product"},"deniedRequestCount":{"type":"integer","description":"Count of denied requests for a data product"},"totalRequestCount":{"type":"integer","description":"Count of total requests for a data product"}},"required":["dataSourceCount","pendingRequestCount","approvedRequestCount","revokedRequestCount","canceledRequestCount","deniedRequestCount","totalRequestCount"],"description":"Data product statistics","title":"Data Product Stats"},"requestId":{"type":"string","format":"cuid","description":"If requested, the ID of the access request for the data product"},"sourceTypes":{"type":"array","items":{"type":"string"},"description":"The types of data sources contained in the data product."},"metadata":{"oneOf":[{"type":"object","properties":{"subjectMatterExpert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Immuta global user ID of the subject matter expert for this data product"},"username":{"type":"string"},"name":{"type":"string"}},"required":["id"]}},"required":["subjectMatterExpert"]}],"nullable":true},"dataAccessPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product data access policy","title":"Data Product Data Access Policy"},"maskingExceptionPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product masking exception policy","title":"Data Product Masking Exception Policy"}},"required":["id","name","domains","suspended","createdBy","createdAt","updatedAt","metadata"]}}},"paths":{"/api/data-product/{id}/datasources":{"put":{"description":"Update the data sources associated with the data product. Any currently associated data sources not included in the payload will be removed.","operationId":"updateDataSources","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDataSources"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProduct"}}}}},"summary":"Update the data product's data sources","tags":["Data Product","Data Source"]}}}}
```

## 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 approvals and all masking exceptions granted by approvals. However, the data product access can be resumed to grant the approvals again.

### With the UI

1. From the [**Data products**](https://app.immutacloud.com/marketplace/data-products) page, select the data product.
2. Navigate to the **Settings** tab.
3. Select **Suspend access** and then click **Suspend access** on the modal.

### With the API

Ensure you set the [correct global segment](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#base-path-and-global-segment) and use a [Request app personal access token (PAT)](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#generate-a-personal-access-token-pat) when using the Request app API. See the [Request app API docs](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api) for additional guidance or to download the OpenAPI YAML for your own client generation.

Update the `suspended` parameter using the endpoint below:

## Update an existing data product

> Update an existing data product by ID

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Data Product","description":"APIs for managing data products"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateDataProduct":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"},"description":{"oneOf":[{"type":"string","description":"Data product description"}],"nullable":true,"description":"Data product description"},"metadata":{"oneOf":[{"type":"object","properties":{"subjectMatterExpert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Immuta global user ID of the subject matter expert for this data product"},"username":{"type":"string"},"name":{"type":"string"}},"required":["id"]}},"required":["subjectMatterExpert"]}],"nullable":true},"domains":{"type":"array","items":{"type":"string"},"minItems":1},"dataAccessPolicy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"]},"maskingExceptionPolicy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"]},"id":{"type":"string","format":"uuid","description":"Data product ID"},"dataSources":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string"}},"required":["sourceId"]}},"requestFormId":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]},"suspended":{"type":"boolean","description":"Whether access to the data product's data sources is suspended"}}},"DataProduct":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"},"description":{"oneOf":[{"type":"string","description":"Data product description"}],"nullable":true,"description":"Data product description"},"domains":{"type":"array","items":{"type":"string"},"minItems":1},"suspended":{"type":"boolean","description":"Whether access to the data product's data sources is suspended"},"createdBy":{"type":"string","format":"uuid","description":"Immuta global user ID of the user who created the data product"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["APPROVED","CANCELED","DENIED","PENDING","NONE","PUBLISHER","REVOKED","EXPIRED"]},"expiration":{"oneOf":[{"type":"string","format":"date-time"}],"nullable":true},"stats":{"type":"object","properties":{"dataSourceCount":{"type":"integer","description":"Count of data sources in a data product"},"pendingRequestCount":{"type":"integer","description":"Count of pending requests for a data product"},"approvedRequestCount":{"type":"integer","description":"Count of approved requests for a data product"},"revokedRequestCount":{"type":"integer","description":"Count of revoked requests for a data product"},"canceledRequestCount":{"type":"integer","description":"Count of canceled requests for a data product"},"deniedRequestCount":{"type":"integer","description":"Count of denied requests for a data product"},"totalRequestCount":{"type":"integer","description":"Count of total requests for a data product"}},"required":["dataSourceCount","pendingRequestCount","approvedRequestCount","revokedRequestCount","canceledRequestCount","deniedRequestCount","totalRequestCount"],"description":"Data product statistics","title":"Data Product Stats"},"requestId":{"type":"string","format":"cuid","description":"If requested, the ID of the access request for the data product"},"sourceTypes":{"type":"array","items":{"type":"string"},"description":"The types of data sources contained in the data product."},"metadata":{"oneOf":[{"type":"object","properties":{"subjectMatterExpert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Immuta global user ID of the subject matter expert for this data product"},"username":{"type":"string"},"name":{"type":"string"}},"required":["id"]}},"required":["subjectMatterExpert"]}],"nullable":true},"dataAccessPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product data access policy","title":"Data Product Data Access Policy"},"maskingExceptionPolicy":{"default":{"rules":[],"defaultEvent":{"type":"review","params":{"stages":[{"any":[{"type":"PERMISSION","permission":"GOVERNANCE"},{"type":"DOMAIN PERMISSION","permission":"Manage Data Products"}]}]}}},"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]}]}},"required":["rules","defaultEvent"],"description":"Data product masking exception policy","title":"Data Product Masking Exception Policy"}},"required":["id","name","domains","suspended","createdBy","createdAt","updatedAt","metadata"]}}},"paths":{"/api/data-product/{id}":{"put":{"description":"Update an existing data product by ID","operationId":"updateDataProduct","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDataProduct"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProduct"}}}}},"summary":"Update an existing data product","tags":["Data Product"]}}}}
```

## 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 and any masking exceptions associated with the data product. **Deleting a data product cannot be undone.**

### **With the UI**

1. From the [**Data products** page](https://app.immutacloud.com/marketplace/data-products), select the data product.
2. Navigate to the **Settings** tab.
3. Click **Delete data product**.
4. 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](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#base-path-and-global-segment) and use a [Request app personal access token (PAT)](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api#generate-a-personal-access-token-pat) when using the Request app API. See the [Request app API docs](https://documentation.immuta.com/SaaS/developer-guides/api-intro/marketplace-api) for additional guidance or to download the OpenAPI YAML for your own client generation.

## Delete data product by ID

> Delete the specified data product from the system

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Data Product","description":"APIs for managing data products"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/api/data-product/{id}":{"delete":{"description":"Delete the specified data product from the system","operationId":"deleteDataProduct","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Delete data product by ID","tags":["Data Product"]}}}}
```


---

# 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/manage-data-products.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.