Manage Data Products

Private preview: The Marketplace app is available to select accounts. Reach out to your Immuta representative for details.

Data product managers are able to publish and manage data products.

Requirement: Immuta permission GOVERNANCE or Manage Data Product in a domain

Publishing a data product

With the UI

From the Marketplace app,

1. Click Publish product.

2. Select the Domain from the dropdown. You will only be able to include data source from this domain in your data product. If you do not see a domain available, create one with at least one data source.

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.

5. Click Next.

6. Enter the following metadata for your new data product:

   • Name of the data product

   • Description of the data product (optional)

   • Enter the subject matter expert (optional). This should be a user that data consumers and stewards can reach out to for any questions about the data product.

7. Click Next.

8. Choose if you would like to require approval for access to this data product:

   • Yes: When the user requests access, in addition to acknowledging the data use agreement and answering the required question, they will need to be approved by one of the approvers. Approvers must have the global GOVERNANCE or domain-specific Manage Data Products permission.

   • No: When the user requests access, they will be automatically approved once they acknowledge the data use agreement and answer any question required for access.

9. Add a data use agreement (optional). You can create a data use agreement yourself or use the default data use agreement. The data use agreement is what the data consumer must agree to when requesting access to your data product.

10. Click Publish Data Product.

With the API

Ensure you set the correct global segment and use a Marketplace specific API key when using the Marketplace API. See the Marketplace API docs 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

post

/api/data-product

Authorizations

Body

namestring · min: 1 · max: 64required

Data product name

Example: Sales

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$

approvalPolicyIdstring · cuidrequired

statusstring · enum

Example: PENDING

Options: APPROVED, CANCELED, DENIED, PENDING, NONE, PUBLISHER, REVOKED

domainsstring[]required

Example: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]

sourceTypesstring[]

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]

descriptionone of | nullable

Data product description

statsData Product Stats

Data product statistics

dataUsageAgreementsobject[]

dataSourcesobject[]required

metadataone of | nullablerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/data-product' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Sales","approvalPolicyId":"text","status":"PENDING","domains":["4d004a3a-4568-4c1d-822e-30958ef898dc"],"sourceTypes":["Databricks","Redshift","Snowflake"],"description":"All sales records from the current fiscal year","stats":{"dataSourceCount":1,"pendingRequestCount":1,"approvedRequestCount":1,"revokedRequestCount":1,"canceledRequestCount":1,"deniedRequestCount":1,"totalRequestCount":1},"dataUsageAgreements":[{"id":"text","name":"text"}],"dataSources":[{"name":"Web Sales 2024","type":"text","sourceId":"text"}],"metadata":{"subjectMatterExpert":{"id":"123e4567-e89b-12d3-a456-426614174000","username":"text"}}}'

201

409

201

{
  "id": "text",
  "name": "Sales",
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-20T19:09:36.541Z",
  "updatedAt": "2025-02-20T19:09:36.541Z",
  "approvalPolicyId": "text",
  "requestId": "text",
  "status": "PENDING",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "description": "All sales records from the current fiscal year",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

There is a short term limitation with the Marketplace app where adding data sources to a data product with active subscription policies set to Always Require could result in currently subscribed users losing access.

Editing data products

Once a data product has been published, many components can be edited from different parts of the data product:

• Details: Edit the name, description, or subject matter expert

• Data sources: Add or remove data sources from the data product

• Request settings: Edit the required approval or the data use agreement

With the UI

From the Marketplace app,

1. 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 and use a Marketplace specific API key when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Update the request settings

To update the request settings of a data product:

1. Run POST /api/approval-policy : Use the ID from the response in the next call.

2. Run PUT/api/data-product/{id} : The ID in the request should be the data product ID and the approval policy ID from the previous call should be included in the payload.

Create an approval policy

Creates a new approval policy based on the provided policy JSON

post

/api/approval-policy

Authorizations

Body

policyJSONobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/approval-policy' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"policyJSON":{"dataAccessAgreements":[null],"stages":[{"name":"text","required":[{"id":"text","type":"USER"}]}]}}'

200

200

{
  "id": "text",
  "policyJSON": {
    "policyVersion": "text",
    "reason": "text",
    "dataAccessAgreements": [
      "text"
    ],
    "stages": [
      {
        "name": "text",
        "required": [
          {
            "id": "text",
            "displayName": "text",
            "type": "USER"
          }
        ]
      }
    ]
  }
}

Update an existing data product

Update an existing data product by ID

put

/api/data-product/{id}

Authorizations

Path parameters

idstringrequired

Body

namestring · min: 1 · max: 64

Data product name

Example: Sales

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$

approvalPolicyIdstring · cuid

suspendedboolean

Whether access to the data product's data sources are suspended

Example: false

statusstring · enum

Example: PENDING

Options: APPROVED, CANCELED, DENIED, PENDING, NONE, PUBLISHER, REVOKED

domainsstring[]

Example: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]

sourceTypesstring[]

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]

descriptionone of | nullable

Data product description

statsData Product Stats

Data product statistics

dataUsageAgreementsobject[]

dataSourcesobject[]

metadataone of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/data-product/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Sales","suspended":false,"status":"PENDING","domains":["4d004a3a-4568-4c1d-822e-30958ef898dc"],"sourceTypes":["Databricks","Redshift","Snowflake"],"description":"All sales records from the current fiscal year","stats":{"dataSourceCount":1,"pendingRequestCount":1,"approvedRequestCount":1,"revokedRequestCount":1,"canceledRequestCount":1,"deniedRequestCount":1,"totalRequestCount":1},"dataUsageAgreements":[{"id":"text","name":"text"}],"dataSources":[{"name":"Web Sales 2024","type":"text","sourceId":"text"}],"metadata":{"subjectMatterExpert":{"id":"123e4567-e89b-12d3-a456-426614174000","username":"text"}}}'

200

200

{
  "id": "text",
  "name": "Sales",
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-20T19:09:36.541Z",
  "updatedAt": "2025-02-20T19:09:36.541Z",
  "approvalPolicyId": "text",
  "requestId": "text",
  "status": "PENDING",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "description": "All sales records from the current fiscal year",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Update the data sources

Ensure you set the correct global segment and use a Marketplace specific API key when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

To update data sources associated with a data product:

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.

put

/api/data-product/{id}/datasources

Authorizations

Path parameters

idstringrequired

Body

dataSourcesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/data-product/{id}/datasources' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"dataSources":[{"name":"Web Sales 2024","type":"text","sourceId":"text"}]}'

200

200

{
  "id": "text",
  "name": "Sales",
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-20T19:09:36.541Z",
  "updatedAt": "2025-02-20T19:09:36.541Z",
  "approvalPolicyId": "text",
  "requestId": "text",
  "status": "PENDING",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "description": "All sales records from the current fiscal year",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Suspend access to data products

Data products can be suspended. Suspending access revokes all access to data sources in the data product that was gained from the manual approvals in the Marketplace. However, the data product access can be resumed to grant the approvals again.

With the UI

From the Marketplace app,

1. Select the data product.

2. Navigate to the Advanced settings tab.

3. Select Suspend Access and then click Suspend Access on the modal.

With the API

Ensure you set the correct global segment and use a Marketplace specific API key when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Update the suspended parameter using the endpoint below:

Update an existing data product

Update an existing data product by ID

put

/api/data-product/{id}

Authorizations

Path parameters

idstringrequired

Body

namestring · min: 1 · max: 64

Data product name

Example: Sales

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$

approvalPolicyIdstring · cuid

suspendedboolean

Whether access to the data product's data sources are suspended

Example: false

statusstring · enum

Example: PENDING

Options: APPROVED, CANCELED, DENIED, PENDING, NONE, PUBLISHER, REVOKED

domainsstring[]

Example: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]

sourceTypesstring[]

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]

descriptionone of | nullable

Data product description

statsData Product Stats

Data product statistics

dataUsageAgreementsobject[]

dataSourcesobject[]

metadataone of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/data-product/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Sales","suspended":false,"status":"PENDING","domains":["4d004a3a-4568-4c1d-822e-30958ef898dc"],"sourceTypes":["Databricks","Redshift","Snowflake"],"description":"All sales records from the current fiscal year","stats":{"dataSourceCount":1,"pendingRequestCount":1,"approvedRequestCount":1,"revokedRequestCount":1,"canceledRequestCount":1,"deniedRequestCount":1,"totalRequestCount":1},"dataUsageAgreements":[{"id":"text","name":"text"}],"dataSources":[{"name":"Web Sales 2024","type":"text","sourceId":"text"}],"metadata":{"subjectMatterExpert":{"id":"123e4567-e89b-12d3-a456-426614174000","username":"text"}}}'

200

200

{
  "id": "text",
  "name": "Sales",
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-20T19:09:36.541Z",
  "updatedAt": "2025-02-20T19:09:36.541Z",
  "approvalPolicyId": "text",
  "requestId": "text",
  "status": "PENDING",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "description": "All sales records from the current fiscal year",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "dataUsageAgreements": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Deleting data products

It is also possible to delete data products, which will remove all users' access to the data sources within the data product. Deleting a data product cannot be undone.

With the UI

From the Marketplace app,

1. Select the data product.

2. Navigate to the Advanced settings tab.

3. Click Edit.

4. Click Delete and then click Delete again.

With the API

Ensure you set the correct global segment and use a Marketplace specific API key when using the Marketplace API. See the Marketplace API docs 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

delete

/api/data-product/{id}

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/data-product/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

No body