Book a demo

Manage Request Forms

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

Data product managers are able to create and manage request forms. Data stewards can edit request forms they are assigned to.

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. Select how you want the review flow determined:

    1. Delegate to data product: Data products 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 access to this data product:

        • Yes: When the user requests access, in addition to acknowledging the data use agreement and answering the required question, they will need to be approved by one of the data stewards.

          • Choose the Immuta source from the dropdowns that will dictate who is a data steward. If you include multiple sources, only one is required to allow the data steward to approve access. If you select a domain permission, the data steward must have that domain-specific permission for the domain the data product is built off of.

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

          • 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.

  6. 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.

  7. 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
post
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": "065de2e5-4366-4b1a-b9c0-e7ef82552e87",
      "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": "84afc80f-a4ab-4522-9fb9-374b6da27e86",
      "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-08-22T15:53:34.152Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-08-22T15:53:34.152Z",
  "version": "text"
}

Edit a request form

Requirement: Immuta permission GOVERNANCE, , or assigned data steward in the request form

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
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": "855cedbc-c4bf-497b-89bf-4a3219d39881",
      "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": "84afc80f-a4ab-4522-9fb9-374b6da27e86",
      "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-08-22T15:53:34.152Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-08-22T15:53:34.152Z",
  "version": "text"
}

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
DELETE /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
204Success
No content
PreviousView and Respond to Access RequestsNextReference Guides

Last updated

Was this helpful?