Access Request

APIs for managing data access

Search access requests

get

Search and filter access requests the current user can manage

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchTextstringOptional

userIdsstring[]Optional

includeTemporarybooleanOptionalDeprecated

Whether to include temporary access requests

Default: false

expirationbooleanOptional

Filter access requests by whether it has an expiration

dataProductIdone ofOptional

The ID of the data product to filter requests by

string · cuidOptional

The ID of the data product to filter requests by

or

string · uuidOptional

assetIdstring · uuidOptional

The ID of the asset to filter requests by

targetTypestring[]Optional

Target type filter selections (DATA_PRODUCT, COLUMNS, or legacy type strings like table/view/schema)

offsetnumberOptionalDefault: 0

limitnumber · min: 1OptionalDefault: 10

sortOrderstring · enumOptionalDefault: descPossible values:

sortBystring · enumOptionalDefault: createdAtPossible values:

Responses

200Success

application/json

get/api/access-request

GET /marketplace/api/access-request HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "data": [
    {
      "id": "text",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text",
        "authorizations": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        }
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text",
        "authorizations": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        }
      },
      "formVersion": "text",
      "form": null,
      "type": "DATA_ACCESS",
      "metadata": null,
      "status": "PENDING",
      "expiration": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "dataProduct": {
        "id": "text",
        "name": "text",
        "description": "All sales records from the current fiscal year"
      },
      "asset": {
        "id": "text",
        "type": "DATA_OBJECT",
        "name": "text",
        "metadata": {
          "subjectMatterExperts": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "username": "text",
              "name": "text"
            }
          ],
          "objectPath": [
            "text"
          ],
          "technology": "Snowflake",
          "host": "text",
          "port": 1,
          "legacyType": "text",
          "dataSourceId": 1,
          "description": "text",
          "externalLink": "text"
        }
      }
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Get the list of approved masking exception columns for the specified user

get

Returns the list of approved masking exception columns for the specified user

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringRequired

Responses

200Success

application/json

List of columns that have been requested for masking exception

columnNamestringRequired

The name of the column to request masking exception for

sourceIdstringRequired

The ID of the data source this column belongs to

get/api/access-request/approved-masking-exception-columns

GET /marketplace/api/access-request/approved-masking-exception-columns?userId=text HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "columnName": "text",
    "sourceId": "text"
  }
]

Get individual access request

get

Returns specific details for a specific access request

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

Access request with user and data product metadata

idstring · cuidRequired

formVersionstringRequired

formanyOptional

The request form submission

typestring · enumRequiredExample: DATA_ACCESSPossible values:

metadataanyOptional

Metadata associated with the access request

statusstring · enumRequiredExample: PENDINGPossible values:

expirationstring · date-timeOptional

When the temporary access will expire

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

get/api/access-request/{id}

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

200Success

{
  "id": "text",
  "requestingUser": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text",
    "email": "text",
    "authorizations": {
      "ANY_ADDITIONAL_PROPERTY": [
        "text"
      ]
    }
  },
  "user": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text",
    "email": "text",
    "authorizations": {
      "ANY_ADDITIONAL_PROPERTY": [
        "text"
      ]
    }
  },
  "formVersion": "text",
  "form": null,
  "type": "DATA_ACCESS",
  "metadata": null,
  "status": "PENDING",
  "expiration": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "dataProduct": {
    "id": "text",
    "name": "text",
    "description": "All sales records from the current fiscal year"
  },
  "asset": {
    "id": "text",
    "type": "DATA_OBJECT",
    "name": "text",
    "metadata": {
      "subjectMatterExperts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "username": "text",
          "name": "text"
        }
      ],
      "objectPath": [
        "text"
      ],
      "technology": "Snowflake",
      "host": "text",
      "port": 1,
      "legacyType": "text",
      "dataSourceId": 1,
      "description": "text",
      "externalLink": "text"
    }
  }
}

Cancel a pending access request

delete

Cancel the specified pending access request by ID, cascading the cancellation to any pending and blocked approval records.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204Success

No content

delete/api/access-request/{id}

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

204Success

No content

Get approval records associated with the a request

get

Returns all approval records associated with a specific access request

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

get/api/access-request/{id}/records

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

200Success

{
  "approvalRecords": [
    {
      "id": "text",
      "dataAccessRequestId": "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",
        "email": "text",
        "authorizations": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        }
      },
      "status": "PENDING",
      "reason": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "approverCriteriaMet": [
        {
          "type": "USER",
          "id": "text",
          "displayName": "text"
        }
      ],
      "duration": 1,
      "durationUnit": "text"
    }
  ]
}

Get the risk assessment for a specific access request

get

Returns the risk assessment for a specific access request

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

or

get/api/access-request/{id}/risk-assessment

GET /marketplace/api/access-request/{id}/risk-assessment HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "conflictDetected": true,
  "approvalRisk": "HIGH",
  "recommendation": "APPROVED",
  "nAllowed": 1,
  "nDenied": 1,
  "riskValue": 1,
  "cohort": {
    "literals": [
      {
        "name": "text",
        "value": "text"
      },
      {
        "negation": true
      }
    ]
  },
  "medianApprovalTimeWindowInDays": 1,
  "explanation": "text",
  "approvalReasons": [
    "text"
  ],
  "denialReasons": [
    "text"
  ]
}

Search masking exception columns associated with the masking exception request

get

Search masking exception columns associated with a specific masking exception request

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Query parameters

offsetnumberOptionalDefault: 0

limitnumber · min: 1OptionalDefault: 10

Responses

200Success

application/json

get/api/access-request/{id}/masking-exception-columns

GET /marketplace/api/access-request/{id}/masking-exception-columns HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "data": [
    {
      "name": "text",
      "sourceId": "text",
      "sourceName": "text",
      "tags": [
        "text"
      ],
      "type": "text",
      "globalPolicyInfo": {
        "maskingType": "text",
        "matchingTag": "text",
        "matchingRegex": "text"
      }
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Approve or reject an approval record

put

Modify a pending approval record as an approver

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

statusstring · enumRequiredExample: PENDINGPossible values:

reasonstringOptional

durationnumber · min: 1Optional

durationUnitstring · enumOptionalPossible values:

Responses

200Success

application/json

idstring · cuidRequired

dataAccessRequestIdstring · cuidRequired

prerequisitesstring[]Required

statusstring · enumRequiredExample: PENDINGPossible values:

reasonstringOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

approverCriteriaMetone of · nullableRequired

durationone of · nullableRequired

numberOptional

durationUnitone of · nullableRequired

stringOptional

put/api/approval-record/{id}

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

{
  "status": "PENDING",
  "reason": "text",
  "duration": 1,
  "durationUnit": "HOURS"
}

200Success

{
  "id": "text",
  "dataAccessRequestId": "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",
    "email": "text",
    "authorizations": {
      "ANY_ADDITIONAL_PROPERTY": [
        "text"
      ]
    }
  },
  "status": "PENDING",
  "reason": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "approverCriteriaMet": [
    {
      "type": "USER",
      "id": "text",
      "displayName": "text"
    }
  ],
  "duration": 1,
  "durationUnit": "text"
}