All pages
Powered by GitBook
1 of 1

View and Respond to Access Requests

Private preview: The Marketplace app is available to select accounts. Contact 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 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.

Search access requests

get

Search and filter access requests the current user can manage

Authorizations
Query parameters
rolestring · enum[] · min: 1 · default: ["requestor","manager"]optional

dataProductIdstring · cuidoptional

The ID of the data product to filter requests by

searchTextstringoptional
statusstring · enum[]optional
Example: PENDING

offsetnumber · default: 0optional
limitnumber · min: 1 · default: 10optional
sortOrderstring · enum · default: "desc"optional
Options: asc, desc
sortBystring · enumrequired
Options: status, dataProduct, createdAt
Responses
curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-request?sortBy=status' \
  --header 'Authorization: Bearer JWT'
{
  "data": [
    {
      "id": "text",
      "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"
      },
      "status": "PENDING",
      "createdAt": "2025-03-30T10:04:37.525Z",
      "updatedAt": "2025-03-30T10:04:37.525Z",
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

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

Search all access requests for the data product

get

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

Authorizations
Path parameters
idstringrequired
Query parameters
searchTextstringoptional
statusstring · enum[]optional
Example: PENDING

offsetnumber · default: 0optional
limitnumber · min: 1 · default: 10optional
sortOrderstring · enum · default: "desc"optional
Options: asc, desc
sortBystring · enumrequired
Options: status, dataProduct, createdAt
Responses
curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/data-product/{id}/request?sortBy=status' \
  --header 'Authorization: Bearer JWT'
{
  "data": [
    {
      "id": "text",
      "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"
      },
      "status": "PENDING",
      "createdAt": "2025-03-30T10:04:37.525Z",
      "updatedAt": "2025-03-30T10:04:37.525Z",
      "dataProduct": {
        "id": "text",
        "name": "Sales",
        "description": "All sales records from the current fiscal year"
      }
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

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

Get individual access request

get

Returns specific details for a specific access request

Authorizations
Path parameters
idstringrequired
Responses
curl -L \
  --url 'https://na.api.immutacloud.com/marketplace/api/access-request/{id}' \
  --header 'Authorization: Bearer JWT'
{
  "id": "text",
  "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"
  },
  "status": "PENDING",
  "createdAt": "2025-03-30T10:04:37.525Z",
  "updatedAt": "2025-03-30T10:04:37.525Z",
  "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 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.

Approve or reject an approval record

put

Modify a pending approval record as an approver

Authorizations
Path parameters
idstringrequired
Body
statusstring · enumrequired
Example: PENDING
Options: APPROVED, BLOCKED, CANCELED, DENIED, PENDING
reasonstringoptional
Responses
curl -L \
  --request PUT \
  --url 'https://na.api.immutacloud.com/marketplace/api/approval-record/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "PENDING",
    "reason": "text"
  }'
{
  "id": "text",
  "approvalPolicyId": "text",
  "dataAccessRequestId": "text",
  "dataAccessAgreementId": "text",
  "approvers": [
    {
      "type": "USER",
      "id": "text",
      "displayName": "text"
    }
  ],
  "prerequisites": [
    "text"
  ],
  "actionBy": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text"
  },
  "status": "PENDING",
  "reason": "text",
  "createdAt": "2025-03-30T10:04:37.525Z",
  "updatedAt": "2025-03-30T10:04:37.525Z"
}