Manage Request Forms

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

Data product managers or data stewards are able to create and manage request forms.

Create a new request form

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

With the UI

From the Marketplace app,

1. Navigate to the Request forms page.

2. Click New request form.

3. Enter the form name, which is how data product owners can add it to their own data product.

4. Enter one or more request questions for the data consumer to answer:

   1. Enter a question and select the answer format in the dropdown.

      1. Short answer: Enter a question that the requester must answer with their own text response.

      2. Dropdown: Enter a question and the options for the dropdown. A requester must answer the question with a single dropdown option.

      3. Checkboxes: Enter a question and the options for the checkboxes. A requester may answer the question with multiple checkbox options.

      4. Access duration: The question and options will be pre-populated. A requester must answer the question with a time range.

   2. Use the switch to dictate if the question is required. Access duration is always required if included.

   3. Click the + icon to add more questions.

5. Navigate to the Review flow tab.

6. 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. Enter the reason users do not need approval.

     • If you included an access duration question, the users will automatically be given access for the duration of time they selected.

7. Add a data use agreement (optional). Use the default data use agreement or Create new +. The data use agreement is what the data consumer must agree to when requesting access to your data product.

8. Click Save.

With the API

Ensure you set the correct global segment and use a Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Create request form

post

Create a request form

Authorizations

Body

idstring · uuidOptional

namestringRequired

dataUseAgreementIdsstring · uuid[]Optional

Responses

201Success

application/json

409

Request form with name already exists.

post

HTTPcURLJavaScriptPython

POST /marketplace/api/request-form HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "768c8bef-ada2-47c0-b32f-da03a4cdb3c1",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "011150c8-e179-4da0-8eb4-5461aa3a0a72",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2025-05-30T04:56:24.350Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-05-30T04:56:24.350Z"
}

Edit a request form

Requirement: Immuta permission GOVERNANCE or

Editing a request form will impact any data products currently using it. However, pending or completed requests will not be retroactively impacted; they will continue to show the request form as it was when the request or approval was made.

With the UI

From the Marketplace app,

1. Navigate to the Request forms page.
2. Click on the name of the request form you want to edit.

3. Make the changes you want.

4. Click Save.

With the API

Ensure you set the correct global segment and use a Marketplace-specific personal access token (PAT) when using the Marketplace API. See the Marketplace API docs for additional guidance or to download the OpenAPI YAML for your own client generation.

Update a request form

put

Update a request form

Authorizations

Path parameters

idstringRequired

Body

idstring · uuidOptional

namestringOptional

dataUseAgreementIdsstring · uuid[]Optional

Responses

201Success

application/json

put

HTTPcURLJavaScriptPython

PUT /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "5c61cfb2-fd80-4f1b-8570-7d9e271fe99a",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "011150c8-e179-4da0-8eb4-5461aa3a0a72",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2025-05-30T04:56:24.350Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-05-30T04:56:24.350Z"
}

Delete a request form

Requirement: Immuta permission GOVERNANCE or

A request form can only be deleted if it is not currently in use in any data product.

With the UI

From the Marketplace app,

1. Navigate to the Request forms page.
2. Click the name of the request for you want to delete.

3. Click Delete.

Delete a request form

delete

Delete a request form

Authorizations

Path parameters

idstringRequired

Responses

204Success

delete

HTTPcURLJavaScriptPython

DELETE /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*

204Success

No content