View and Respond to Access Requests

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

Data stewards are able to make determinations on access requests.

Requirement: Immuta permission GOVERNANCE or Manage Data Product in the domain where the data product was published from.

View access requests

With the UI

In the Marketplace app,

1. Navigate to the Access Requests page.

2. Opt to filter by status or sort the table by data product, status, or date.

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.

Search access requests

Search and filter access requests the current user can manage

get

/api/access-request

Authorizations

Query parameters

rolestring · enum[] · default: requestor,manager

dataProductIdstring · cuid

The id of the data product to filter requests by

searchTextstring

statusstring · enum[]

offsetnumber

limitnumber · min: 1 · default: 10

sortOrderstring · enum · default: desc

Options: asc, desc

sortBystring · enumrequired

Options: status, dataProduct, createdAt

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/access-request?sortBy=status' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "data": [
    {
      "id": "text",
      "createdAt": "2025-02-20T19:09:46.754Z",
      "updatedAt": "2025-02-20T19:09:46.754Z",
      "status": "PENDING",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ]
}

View the access requests of a specific data product

With the UI

In the Marketplace app,

1. Navigate to the Data Product you want to view requests for.

2. Click the Access Requests tab.

3. Opt to filter by status or sort the table by data product, status, or date.

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.

Search all access requests for the data product

Search all access requests for the data product using the provided filters

get

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

Authorizations

Path parameters

idstringrequired

Query parameters

searchTextstring

statusstring · enum[]

offsetnumber

limitnumber · min: 1 · default: 10

sortOrderstring · enum · default: desc

Options: asc, desc

sortBystring · enumrequired

Options: status, dataProduct, createdAt

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "data": [
    {
      "id": "text",
      "createdAt": "2025-02-20T19:09:46.754Z",
      "updatedAt": "2025-02-20T19:09:46.754Z",
      "status": "PENDING",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text"
      },
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ]
}

View the approval record for a request

With the UI

In the Marketplace app,

1. Navigate to the Access Requests page.

2. Click the request you want the details for.

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.

Get individual access request

Returns specific details for a specific access request

get

/api/access-request/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "text",
  "createdAt": "2025-02-20T19:09:46.754Z",
  "updatedAt": "2025-02-20T19:09:46.754Z",
  "status": "PENDING",
  "requestingUser": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "user": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "dataProduct": {
    "id": "text",
    "name": "Sales",
    "description": "All sales records from the current fiscal year"
  }
}

Respond to an access request

With the UI

In the Marketplace app,

1. Navigate to the Access Requests page.

2. Click the request you want to approve or deny.

3. Review the request details, data sources, and data use agreement.

4. Select Deny or Approve:

   1. Deny: Enter your reason to deny access to the data product and click Confirm denial.

   2. Approve: Enter your reason to approve access to the data product and click Confirm approval.

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.

Approve or reject an approval record

Modify a pending approval record as an approver

put

/api/approval-record/{id}

Authorizations

Path parameters

idstringrequired

Body

reasonstring

statusstring · enumrequired

Example: PENDING

Options: APPROVED, BLOCKED, CANCELED, DENIED, PENDING

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://{global-segment}.api.immutacloud.com/marketplace/api/approval-record/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"status":"PENDING"}'

200

200

{
  "id": "text",
  "approvalPolicyId": "text",
  "dataAccessRequestId": "text",
  "dataAccessAgreementId": "text",
  "reason": "text",
  "createdAt": "2025-02-20T19:09:46.754Z",
  "updatedAt": "2025-02-20T19:09:46.754Z",
  "status": "PENDING",
  "prerequisites": [
    "text"
  ],
  "actionBy": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "approvers": [
    {
      "id": "text",
      "displayName": "text",
      "type": "USER"
    }
  ]
}