Manage Request Forms

Create, edit, or delete request forms

Governance users and 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 Products in a domain

With the UI

Navigate to the Request forms page.
Click New request form.
Enter the form name, which is how other users can add it to their own assets or data products.
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. Single select: Enter a question and the options for the dropdown. A requester must answer the question with a single dropdown option.
  3. Multi select: Enter a question and the options for the dropdown. A requester may answer the question with multiple 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.
Select how you want the review flow determined:
1. Delegate: Assets and 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 assets and data products.
  1. Choose if you would like to require approval for requests on this data:
    Review required: When the user makes a request on an asset or 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.
    Automatically approve: When the user makes a request on an asset or data product, 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.
    Choose if the approved requests should expire:
    Never: Requests are approved indefinitely and can be manually revoked.
    After a set duration: Use the dropdown to select how long users will have access to the data before the access expires.
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.
Click Save.

With the API

Ensure you set the correct global segment and use a Request app personal access token (PAT) when using the Request app API. See the Request app 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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

idstring · uuidOptional

dataUseAgreementIdsstring · uuid[]Optional

Responses

201Success

application/json

idstring · uuidRequired

namestringRequired

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

versionstring · cuidRequired

The current version of the request form

409

Request form with name already exists.

post/api/request-form

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

{
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      }
    }
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "version": "text"
}

Edit a request form

Requirement: Immuta permission GOVERNANCE, Manage Data Products in a domain, or assigned data steward in the request form

Editing a request form will impact any assets or 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.

Editing the Standard Request Form is not supported.

With the UI

Navigate to the Request forms page.
Click on the name of the request form you want to edit.
Make the changes you want.
Click Save.

With the API

Update request form by ID

put

Update a request form

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

namestringOptional

idstring · uuidOptional

dataUseAgreementIdsstring · uuid[]Optional

Responses

201Success

application/json

idstring · uuidRequired

namestringRequired

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

versionstring · cuidRequired

The current version of the request form

put/api/request-form/{id}

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

{
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
      }
    }
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "version": "text"
}

Delete a request form

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

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

With the UI

Navigate to the Request forms page.
Click the name of the request form you want to delete.
Click Delete.

With the API

Delete request form by ID

delete

Delete a request form

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204Success

No content

delete/api/request-form/{id}

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

204Success

No content

PreviousView and Respond to Access Requests NextReference Guides

Last updated 1 month ago

Was this helpful?