openapi: 3.2.0 info: title: Immuta Data Marketplace Data Product API description: This is the API for the Immuta Data Marketplace based on the OpenAPI 3.0 specification. The API supports the discovery and management of data products as well as access to those products including both the request and approval process. version: '1.0' contact: name: Support url: https://support.immuta.com email: support@immuta.com termsOfService: https://www.immuta.com/terms-of-service license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{global-segment}.api.immutacloud.com/marketplace description: Marketplace API Endpoint variables: global-segment: default: na enum: - na - eu - ap description: Marketplace API global segment tags: - name: Data Product description: APIs for managing data products paths: /api/data-product: get: description: Search data products in the marketplace using the provided filters operationId: searchDataProducts parameters: - name: nextToken required: false in: query description: Pagination token to fetch the next page of results schema: type: string - name: limit required: false in: query description: The number of items to return per page schema: minimum: 1 maximum: 100 default: 10 type: number - name: sortOrder required: false in: query schema: default: asc type: string enum: - asc - desc - name: sortBy required: false in: query schema: type: string enum: - name - name: nameFilter required: false in: query schema: type: string - name: statusFilter required: false in: query schema: minItems: 0 type: array items: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED - name: roleFilter required: false in: query schema: minItems: 0 type: array items: type: string enum: - manager - member - noRole - steward - name: expiration required: false in: query description: Filter data products by whether data access has an expiration. schema: type: boolean responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedDataProduct' security: - bearer: [] summary: Search data products across the marketplace tags: - Data Product post: description: Add one or more data products to the marketplace operationId: createDataProduct parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDataProduct' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/DataProduct' '409': description: Data Product name in use. security: - bearer: [] summary: Add new data products to the marketplace tags: - Data Product /api/data-product/{id}: get: description: Get data product metadata for the specified data product ID operationId: getDataProductById parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DataProduct' security: - bearer: [] summary: Get data product by ID tags: - Data Product put: description: Update an existing data product by ID operationId: updateDataProduct parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDataProduct' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DataProduct' security: - bearer: [] summary: Update an existing data product tags: - Data Product delete: description: Delete the specified data product from the system operationId: deleteDataProduct parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] summary: Delete data product by ID tags: - Data Product /api/data-product/{name}/byName: get: description: Get data product metadata for the specified data product name operationId: getDataProductByName parameters: - name: name required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DataProduct' security: - bearer: [] summary: Get data product by name tags: - Data Product /api/data-product/{id}/datasources: put: description: Update the data sources associated with the data product. Any currently associated data sources not included in the payload will be removed. operationId: updateDataSources parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDataSources' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DataProduct' security: - bearer: [] summary: Update the data product's data sources tags: - Data Product get: description: Search all data sources for the data product using the provided filters operationId: searchDataSources parameters: - name: id required: true in: path schema: type: string - name: nextToken required: false in: query description: Pagination token to fetch the next page of results schema: type: string - name: limit required: false in: query description: The number of items to return per page schema: minimum: 1 maximum: 100 default: 10 type: number - name: user required: false in: query description: The global user ID to search data source access status for schema: format: uuid type: string - name: nameFilter required: false in: query description: Data source name to filter by schema: default: '' oneOf: - type: string description: Data source name to filter by - type: string minLength: 0 maxLength: 0 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedDataSourceWithStatus' security: - bearer: [] summary: Search all data sources in the data product tags: - Data Product /api/data-product/{id}/request: get: description: Search all access requests for the data product using the provided filters operationId: searchDataProductAccessRequests parameters: - name: id required: true in: path schema: type: string - name: searchText required: false in: query schema: type: string - name: status required: false in: query schema: minItems: 0 type: array items: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED example: PENDING - name: type required: false in: query schema: minItems: 0 type: array items: type: string enum: - DATA_ACCESS - MASKING_EXCEPTION example: DATA_ACCESS - name: userIds required: false in: query schema: minItems: 0 type: array items: type: string - name: includeTemporary required: false in: query description: Whether to include temporary access requests deprecated: true schema: default: false type: boolean - name: expiration required: false in: query description: Filter access requests by whether it has an expiration schema: type: boolean - name: dataProductId required: false in: query description: The ID of the data product to filter requests by schema: oneOf: - type: string format: cuid description: The ID of the data product to filter requests by - type: string format: uuid - name: assetId required: false in: query description: The ID of the asset to filter requests by schema: format: uuid type: string - name: assetType required: false in: query description: Filter access requests by asset type (DATA_OBJECT or DATA_PRODUCT) schema: minItems: 0 type: array items: type: string enum: - DATA_PRODUCT - DATA_OBJECT - name: targetType required: false in: query description: Target type filter selections (DATA_PRODUCT, COLUMNS, or legacy type strings like table/view/schema) schema: minItems: 0 type: array items: type: string - name: reviewStatus required: false in: query description: Filter access requests by review status schema: minItems: 0 type: array items: type: string enum: - noReviews - reviewedByYou - awaitingReviewFromYou - name: offset required: false in: query schema: minimum: 0 default: 0 type: number - name: limit required: false in: query schema: minimum: 1 default: 10 type: number - name: sortOrder required: false in: query schema: default: desc type: string enum: - asc - desc - name: sortBy required: false in: query schema: default: createdAt type: string enum: - status - dataProduct - createdAt - updatedAt - expiration responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedAccessRequest' security: - bearer: [] summary: Search all access requests for the data product tags: - Data Product post: description: Create a new data access request for the specified data product operationId: requestAccess parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAccessRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/HydratedAccessRequest' security: - bearer: [] summary: Request access to a data product tags: - Data Product /api/data-product/{id}/members: get: description: Search all approved access requests for the data product operationId: searchDataProductMembers parameters: - name: id required: true in: path schema: type: string - name: searchText required: false in: query schema: type: string - name: status required: false in: query schema: minItems: 0 type: array items: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED example: PENDING - name: type required: false in: query schema: minItems: 0 type: array items: type: string enum: - DATA_ACCESS - MASKING_EXCEPTION example: DATA_ACCESS - name: userIds required: false in: query schema: minItems: 0 type: array items: type: string - name: expiration required: false in: query description: Filter access requests by whether it has an expiration schema: type: boolean - name: dataProductId required: false in: query description: The ID of the data product to filter requests by schema: oneOf: - type: string format: cuid description: The ID of the data product to filter requests by - type: string format: uuid - name: assetId required: false in: query description: The ID of the asset to filter requests by schema: format: uuid type: string - name: assetType required: false in: query description: Filter access requests by asset type (DATA_OBJECT or DATA_PRODUCT) schema: minItems: 0 type: array items: type: string enum: - DATA_PRODUCT - DATA_OBJECT - name: targetType required: false in: query description: Target type filter selections (DATA_PRODUCT, COLUMNS, or legacy type strings like table/view/schema) schema: minItems: 0 type: array items: type: string - name: reviewStatus required: false in: query description: Filter access requests by review status schema: minItems: 0 type: array items: type: string enum: - noReviews - reviewedByYou - awaitingReviewFromYou - name: offset required: false in: query schema: minimum: 0 default: 0 type: number - name: limit required: false in: query schema: minimum: 1 default: 10 type: number - name: sortOrder required: false in: query schema: default: desc type: string enum: - asc - desc - name: sortBy required: false in: query schema: default: createdAt type: string enum: - status - dataProduct - createdAt - updatedAt - expiration responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedAccessRequest' security: - bearer: [] summary: Search all access requests for the data product tags: - Data Product /api/data-product/{id}/request/masking-exception: post: description: Create a new masking exception request for specific columns in the specified data product operationId: requestMaskingException parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMaskingExceptionRequest' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/HydratedAccessRequest' security: - bearer: [] summary: Request masking exception to columns in a data product tags: - Data Product /api/data-product/{id}/request/{requestId}: delete: description: Updates the specified access request to revoked and revokes access to data sources associated with the data product operationId: revokeAccess parameters: - name: id required: true in: path schema: type: string - name: requestId required: true in: path schema: type: string responses: '204': description: '' security: - bearer: [] summary: Revoke access to a data product tags: - Data Product /api/data-product/{id}/datasources/all: get: description: Get all data sources in the data product operationId: getAllDataSources parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AllDataSources' security: - bearer: [] summary: Get all data sources in the data product tags: - Data Product /api/data-product/{id}/recent-determinations: get: description: Returns 5 most recent data access requests with a terminal status as well as the approval records which contributed to that status. operationId: recentDeterminations parameters: - name: id required: true in: path schema: type: string - name: type required: false in: query schema: default: DATA_ACCESS type: string enum: - DATA_ACCESS - MASKING_EXCEPTION responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RecentDeterminations' security: - bearer: [] summary: Returns 5 most recent manual access determinations tags: - Data Product /api/data-product/{id}/request-forms: get: description: Get all the request forms for the specified data product operationId: getRequestForms parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/DataProductRequestForm' security: - bearer: [] summary: View all request forms for a data product tags: - Data Product /api/data-product/{id}/columns: get: description: Search and filter columns in the data product using the provided filters operationId: searchDataProductColumns parameters: - name: id required: true in: path schema: type: string - name: offset required: false in: query schema: minimum: 0 default: 0 type: number - name: limit required: false in: query schema: minimum: 1 default: 10 type: number - name: sortOrder required: false in: query schema: default: asc type: string enum: - asc - desc - name: searchText required: false in: query description: Search text to filter data source columns schema: type: string - name: maskedOnly required: false in: query description: Whether to filter columns that have a masking policy applied to them schema: default: false type: boolean - name: tagIds required: false in: query schema: minItems: 0 default: [] type: array items: type: string - name: dir required: false in: query schema: default: ASC type: string enum: - ASC - DESC - name: dataSourceIds required: false in: query schema: minItems: 0 default: [] type: array items: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedImmutaDataSourceColumns' security: - bearer: [] summary: Search columns in data product tags: - Data Product components: schemas: CreateMaskingExceptionRequest: type: object properties: user: type: string format: uuid description: Immuta global user ID of the user for whom access is being requested form: description: The request form submission columns: type: array items: type: object properties: columnName: type: string description: The name of the column to request masking exception for sourceId: type: string description: The ID of the data source this column belongs to required: - columnName - sourceId description: Column in the data source to request masking exception for description: List of columns to request masking exception for required: - user - columns DataProduct: type: object properties: id: oneOf: - type: string format: cuid - type: string format: uuid name: type: string minLength: 1 maxLength: 255 pattern: ^[\p{L}\p{M}\p{N})(\-_/\\\s]*$ description: Data product name description: oneOf: - type: string description: Data product description example: All sales records from the current fiscal year description: Data product description domains: type: array items: type: string minItems: 1 example: - 4d004a3a-4568-4c1d-822e-30958ef898dc suspended: type: boolean description: Whether access to the data product's data sources is suspended example: false createdBy: type: string format: uuid description: Immuta global user ID of the user who created the data product createdAt: type: string format: date-time updatedAt: type: string format: date-time status: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED example: PENDING expiration: oneOf: - type: string format: date-time stats: type: object properties: dataSourceCount: type: integer description: Count of data sources in a data product pendingRequestCount: type: integer description: Count of pending requests for a data product approvedRequestCount: type: integer description: Count of approved requests for a data product revokedRequestCount: type: integer description: Count of revoked requests for a data product canceledRequestCount: type: integer description: Count of canceled requests for a data product deniedRequestCount: type: integer description: Count of denied requests for a data product totalRequestCount: type: integer description: Count of total requests for a data product required: - dataSourceCount - pendingRequestCount - approvedRequestCount - revokedRequestCount - canceledRequestCount - deniedRequestCount - totalRequestCount description: Data product statistics title: Data Product Stats requestId: type: string format: cuid description: If requested, the ID of the access request for the data product sourceTypes: type: array items: type: string description: The types of data sources contained in the data product. example: - Databricks - Redshift - Snowflake metadata: oneOf: - type: object properties: subjectMatterExpert: type: object properties: id: type: string format: uuid description: Immuta global user ID of the subject matter expert for this data product username: type: string name: type: string required: - id required: - subjectMatterExpert dataAccessPolicy: default: rules: [] defaultEvent: type: review params: stages: - any: - type: PERMISSION permission: GOVERNANCE - type: DOMAIN PERMISSION permission: Manage Data Products type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Data product data access policy title: Data Product Data Access Policy maskingExceptionPolicy: default: rules: [] defaultEvent: type: review params: stages: - any: - type: PERMISSION permission: GOVERNANCE - type: DOMAIN PERMISSION permission: Manage Data Products type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Data product masking exception policy title: Data Product Masking Exception Policy required: - id - name - domains - suspended - createdBy - createdAt - updatedAt - metadata DataProductRequestForm: type: object properties: id: type: string format: uuid name: type: string fields: type: array items: discriminator: propertyName: type oneOf: - type: object properties: id: type: string format: uuid type: type: string enum: - DROPDOWN - CHECKBOXES label: type: string required: default: true type: boolean options: type: array items: type: object properties: value: type: string required: - value required: - id - type - label - options title: Selection Form Field - type: object properties: id: type: string format: uuid type: type: string enum: - SHORT_ANSWER label: type: string required: default: true type: boolean required: - id - type - label title: Short Answer Form Field - type: object properties: id: type: string format: uuid type: type: string enum: - ACCESS_DURATION label: type: string enum: - How long do you need access to this data? required: type: boolean enum: - true required: - id - type - label - required title: Access Duration Form Field title: RequestFormFields policy: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - rules - defaultEvent dataUseAgreements: default: [] type: array items: type: object properties: id: type: string format: uuid name: type: string description: The name of data use agreement body: type: string description: The contents of data use agreement required: - id - name - body title: Request Form Data Use Agreements createdBy: type: object properties: globalUserId: type: string format: uuid description: Immuta global user ID name: type: string description: Display name required: - globalUserId - name description: The user who originally created the request form createdAt: oneOf: - type: string format: date-time - type: string format: date-time updatedBy: type: object properties: globalUserId: type: string format: uuid description: Immuta global user ID name: type: string description: Display name required: - globalUserId - name description: The user who last updated the request form updatedAt: oneOf: - type: string format: date-time - type: string format: date-time version: type: string format: cuid description: The current version of the request form inheritedFrom: type: object properties: id: oneOf: - type: string format: cuid - type: string format: uuid name: type: string minLength: 1 description: Asset name type: type: string enum: - DATA_OBJECT createdAt: oneOf: - type: string format: date-time - type: string format: date-time updatedAt: oneOf: - type: string format: date-time - type: string format: date-time dagTagId: oneOf: - type: number requestId: type: string format: cuid description: If requested, the ID of the access request for the asset status: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED example: PENDING metadata: type: object properties: subjectMatterExperts: default: [] type: array items: type: object properties: id: type: string format: uuid description: Immuta global user ID of the subject matter expert username: type: string name: type: string required: - id objectPath: type: array items: type: string technology: type: string enum: - Snowflake - PostgreSQL - Databricks - Glue - MySQL - Teradata - MariaDB - Oracle - SQLServer - Trino - Redshift - BigQuery host: type: string port: type: integer minimum: 1 maximum: 65535 legacyType: type: string dataSourceId: type: number description: oneOf: - type: string externalLink: oneOf: - type: string required: - objectPath description: Data object asset metadata registered: default: true type: boolean description: Whether the asset has been registered stats: type: object properties: dataSourceCount: type: integer description: Count of data sources in the data object required: - dataSourceCount description: Data object asset statistics title: Data Object Asset Stats required: - id - name - type - metadata title: Data Object Asset requestType: type: string enum: - DATA_ACCESS - MASKING_EXCEPTION required: - id - name - fields - policy - createdBy - createdAt - updatedBy - updatedAt - version - requestType HydratedAccessRequest: type: object properties: id: type: string format: cuid requestingUser: type: object properties: id: type: number iamId: type: string description: ID of the IAM the user is associated with globalUserId: type: string format: uuid description: Immuta global user ID username: type: string description: Username/login name for the user name: type: string description: Display name email: type: - string - 'null' description: Email address authorizations: type: object additionalProperties: type: array items: type: string required: - id - iamId - globalUserId - username - name title: Immuta User user: type: object properties: id: type: number iamId: type: string description: ID of the IAM the user is associated with globalUserId: type: string format: uuid description: Immuta global user ID username: type: string description: Username/login name for the user name: type: string description: Display name email: type: - string - 'null' description: Email address authorizations: type: object additionalProperties: type: array items: type: string required: - id - iamId - globalUserId - username - name title: Immuta User formVersion: type: string form: description: The request form submission type: type: string enum: - DATA_ACCESS - MASKING_EXCEPTION example: DATA_ACCESS metadata: description: Metadata associated with the access request status: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED example: PENDING expiration: type: string format: date-time description: When the temporary access will expire createdAt: type: string format: date-time updatedAt: type: string format: date-time dataProduct: type: object properties: id: oneOf: - type: string format: cuid - type: string format: uuid name: type: string minLength: 1 maxLength: 255 pattern: ^[\p{L}\p{M}\p{N})(\-_/\\\s]*$ description: Data product name description: oneOf: - type: string description: Data product description example: All sales records from the current fiscal year description: Data product description required: - id - name asset: type: object properties: id: oneOf: - type: string format: cuid - type: string format: uuid type: type: string enum: - DATA_OBJECT name: type: string minLength: 1 description: Asset name metadata: type: object properties: subjectMatterExperts: default: [] type: array items: type: object properties: id: type: string format: uuid description: Immuta global user ID of the subject matter expert username: type: string name: type: string required: - id objectPath: type: array items: type: string technology: type: string enum: - Snowflake - PostgreSQL - Databricks - Glue - MySQL - Teradata - MariaDB - Oracle - SQLServer - Trino - Redshift - BigQuery host: type: string port: type: integer minimum: 1 maximum: 65535 legacyType: type: string dataSourceId: type: number description: oneOf: - type: string externalLink: oneOf: - type: string required: - objectPath description: Data object asset metadata required: - id - type - name - metadata required: - id - requestingUser - user - formVersion - type - status - createdAt - updatedAt title: Hydrated Access Request description: Access request with user and data product metadata PaginatedImmutaDataSourceColumns: type: object properties: data: type: array items: type: object properties: name: type: string description: Name of the column sourceId: type: string description: The ID of the data source containing the column sourceName: type: string description: The name of the data source containing the column tags: type: array items: type: string description: Tags associated with the column type: type: string description: The data source technology/platform type globalPolicyInfo: type: - object - 'null' properties: maskingType: type: string description: The type of masking policy that was applied required: - maskingType localPolicyInfo: type: - object - 'null' properties: maskingType: type: string description: The type of masking policy that was applied required: - maskingType required: - name - sourceId - sourceName - tags meta: type: object properties: offset: default: 0 type: number minimum: 0 limit: default: 10 type: number minimum: 1 totalCount: type: number pageCount: type: number currentPage: type: number totalPages: type: number required: - totalCount - pageCount - currentPage - totalPages required: - data - meta RecentDeterminations: type: object properties: determinations: type: array items: type: object properties: id: type: string format: cuid requestingUser: type: object properties: id: type: number iamId: type: string description: ID of the IAM the user is associated with globalUserId: type: string format: uuid description: Immuta global user ID username: type: string description: Username/login name for the user name: type: string description: Display name email: type: - string - 'null' description: Email address authorizations: type: object additionalProperties: type: array items: type: string required: - id - iamId - globalUserId - username - name title: Immuta User user: type: object properties: id: type: number iamId: type: string description: ID of the IAM the user is associated with globalUserId: type: string format: uuid description: Immuta global user ID username: type: string description: Username/login name for the user name: type: string description: Display name email: type: - string - 'null' description: Email address authorizations: type: object additionalProperties: type: array items: type: string required: - id - iamId - globalUserId - username - name title: Immuta User actionBy: type: - object - 'null' properties: id: type: number iamId: type: string description: ID of the IAM the user is associated with globalUserId: type: string format: uuid description: Immuta global user ID username: type: string description: Username/login name for the user name: type: string description: Display name email: type: - string - 'null' description: Email address authorizations: type: object additionalProperties: type: array items: type: string required: - id - iamId - globalUserId - username - name title: Immuta User reason: type: string status: type: string enum: - APPROVED - BLOCKED - CANCELED - DENIED - PENDING example: PENDING createdAt: type: string format: date-time updatedAt: type: string format: date-time expiration: type: string format: date-time required: - id - requestingUser - user - actionBy - status - createdAt - updatedAt required: - determinations title: Recent Data Product Manual Determinations PaginatedDataProduct: type: object properties: data: type: array items: type: object properties: id: oneOf: - type: string format: cuid - type: string format: uuid name: type: string minLength: 1 maxLength: 255 pattern: ^[\p{L}\p{M}\p{N})(\-_/\\\s]*$ description: Data product name description: oneOf: - type: string description: Data product description example: All sales records from the current fiscal year description: Data product description domains: type: array items: type: string minItems: 1 example: - 4d004a3a-4568-4c1d-822e-30958ef898dc suspended: type: boolean description: Whether access to the data product's data sources is suspended example: false createdBy: type: string format: uuid description: Immuta global user ID of the user who created the data product createdAt: type: string format: date-time updatedAt: type: string format: date-time status: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED example: PENDING expiration: oneOf: - type: string format: date-time stats: type: object properties: dataSourceCount: type: integer description: Count of data sources in a data product pendingRequestCount: type: integer description: Count of pending requests for a data product approvedRequestCount: type: integer description: Count of approved requests for a data product revokedRequestCount: type: integer description: Count of revoked requests for a data product canceledRequestCount: type: integer description: Count of canceled requests for a data product deniedRequestCount: type: integer description: Count of denied requests for a data product totalRequestCount: type: integer description: Count of total requests for a data product required: - dataSourceCount - pendingRequestCount - approvedRequestCount - revokedRequestCount - canceledRequestCount - deniedRequestCount - totalRequestCount description: Data product statistics title: Data Product Stats requestId: type: string format: cuid description: If requested, the ID of the access request for the data product sourceTypes: type: array items: type: string description: The types of data sources contained in the data product. example: - Databricks - Redshift - Snowflake metadata: oneOf: - type: object properties: subjectMatterExpert: type: object properties: id: type: string format: uuid description: Immuta global user ID of the subject matter expert for this data product username: type: string name: type: string required: - id required: - subjectMatterExpert dataAccessPolicy: default: rules: [] defaultEvent: type: review params: stages: - any: - type: PERMISSION permission: GOVERNANCE - type: DOMAIN PERMISSION permission: Manage Data Products type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Data product data access policy title: Data Product Data Access Policy maskingExceptionPolicy: default: rules: [] defaultEvent: type: review params: stages: - any: - type: PERMISSION permission: GOVERNANCE - type: DOMAIN PERMISSION permission: Manage Data Products type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Data product masking exception policy title: Data Product Masking Exception Policy required: - id - name - domains - suspended - createdBy - createdAt - updatedAt - metadata meta: type: object properties: nextToken: oneOf: - type: string description: Pagination token to fetch the next page of results, or null if there are no more pages. description: Pagination token to fetch the next page of results, or null if there are no more pages. limit: default: 10 type: number minimum: 1 maximum: 100 description: The number of items to return per page required: - nextToken required: - data - meta CreateDataProduct: type: object properties: name: type: string minLength: 1 maxLength: 255 pattern: ^[\p{L}\p{M}\p{N})(\-_/\\\s]*$ description: Data product name description: oneOf: - type: string description: Data product description example: All sales records from the current fiscal year description: Data product description metadata: oneOf: - type: object properties: subjectMatterExpert: type: object properties: id: type: string format: uuid description: Immuta global user ID of the subject matter expert for this data product username: type: string name: type: string required: - id required: - subjectMatterExpert domains: type: array items: type: string minItems: 1 example: - 4d004a3a-4568-4c1d-822e-30958ef898dc id: type: string format: uuid description: Data product ID dataSources: type: array items: type: object properties: sourceId: type: string required: - sourceId dataAccessPolicy: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent deprecated: true description: Deprecated. Use dataAccessReviewFlow instead. maskingExceptionPolicy: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent deprecated: true description: Deprecated. Use maskingExceptionReviewFlow instead. requestFormId: oneOf: - type: string format: cuid - type: string format: uuid deprecated: true description: Deprecated. Use dataAccessRequestFormId and maskingExceptionRequestFormId together, or keep using this field to set both to the same form. dataAccessRequestFormId: oneOf: - type: string format: cuid - type: string format: uuid description: The request form ID for the data access review flow. maskingExceptionRequestFormId: oneOf: - type: string format: cuid - type: string format: uuid description: The request form ID for the masking exception review flow. dataAccessReviewFlow: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Data access review flow for the data product. maskingExceptionReviewFlow: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Masking exception review flow for the data product. required: - name - metadata - domains - dataSources PaginatedDataSourceWithStatus: type: object properties: data: type: array items: type: object properties: id: type: string format: cuid name: type: string example: Web Sales 2024 type: type: string sourceId: type: string hostname: oneOf: - type: string description: Data source hostname description: Data source hostname database: oneOf: - type: string description: Data source database name description: Data source database name schema: oneOf: - type: string description: Data source schema name description: Data source schema name table: oneOf: - type: string description: Data source table name description: Data source table name prefix: oneOf: - type: string description: The native S3 prefix description: The native S3 prefix status: type: string enum: - NONE - RESTRICTED - SUBSCRIBED description: Govern app subscription status required: - id - name - type - sourceId - status meta: type: object properties: nextToken: oneOf: - type: string description: Pagination token to fetch the next page of results, or null if there are no more pages. description: Pagination token to fetch the next page of results, or null if there are no more pages. limit: default: 10 type: number minimum: 1 maximum: 100 description: The number of items to return per page required: - nextToken required: - data - meta UpdateDataProduct: type: object properties: name: type: string minLength: 1 maxLength: 255 pattern: ^[\p{L}\p{M}\p{N})(\-_/\\\s]*$ description: Data product name description: oneOf: - type: string description: Data product description example: All sales records from the current fiscal year description: Data product description metadata: oneOf: - type: object properties: subjectMatterExpert: type: object properties: id: type: string format: uuid description: Immuta global user ID of the subject matter expert for this data product username: type: string name: type: string required: - id required: - subjectMatterExpert domains: type: array items: type: string minItems: 1 example: - 4d004a3a-4568-4c1d-822e-30958ef898dc id: type: string format: uuid description: Data product ID dataAccessPolicy: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent deprecated: true description: Deprecated. Use dataAccessReviewFlow instead. maskingExceptionPolicy: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent deprecated: true description: Deprecated. Use maskingExceptionReviewFlow instead. requestFormId: oneOf: - type: string format: cuid - type: string format: uuid deprecated: true description: Deprecated. Use dataAccessRequestFormId and maskingExceptionRequestFormId together, or keep using this field to set both to the same form. dataAccessRequestFormId: oneOf: - type: string format: cuid - type: string format: uuid description: The request form ID for the data access review flow. maskingExceptionRequestFormId: oneOf: - type: string format: cuid - type: string format: uuid description: The request form ID for the masking exception review flow. dataAccessReviewFlow: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Data access review flow for the data product. maskingExceptionReviewFlow: type: object properties: version: type: string description: Policy schema version rules: type: array items: type: object properties: conditions: oneOf: - type: object properties: all: type: array items: {} required: - all additionalProperties: false - type: object properties: any: type: array items: {} required: - any additionalProperties: false - type: object properties: not: {} required: - not additionalProperties: false event: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - deny params: type: object properties: comment: type: string required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params - type: object properties: type: type: string enum: - dataProductPolicy required: - type required: - conditions - event defaultEvent: discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - approve params: type: object properties: comment: type: string duration: type: number minimum: 1 durationUnit: type: string enum: - HOURS - DAYS - WEEKS - MONTHS - YEARS additionalProperties: false required: - type - params - type: object properties: type: type: string enum: - review params: type: object properties: stages: type: array items: oneOf: - type: object properties: all: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - all - type: object properties: any: type: array items: oneOf: - type: object properties: type: type: string enum: - USER description: Entity type id: type: string description: Entity ID displayName: type: string description: Entity display name required: - type - id - type: object properties: type: type: string enum: - GROUP description: Entity type id: type: number description: Entity ID iamId: type: string description: IAM ID name: type: string description: Entity display name required: - type - name - type: object properties: type: type: string enum: - PERMISSION permission: type: string enum: - GOVERNANCE - USER_ADMIN - AUDIT description: Global permission required: - type - permission - type: object properties: type: type: string enum: - DOMAIN PERMISSION permission: type: string enum: - Manage Policies - Audit Activity - Manage Data Products - Manage Identifiers description: Domain permission domainId: type: string description: Domain ID required: - type - permission - type: object properties: type: type: string enum: - ATTRIBUTE key: type: string description: Attribute key value: type: string description: Attribute value required: - type - key - value - type: object properties: type: type: string enum: - CATALOG PERMISSION required: - type minItems: 1 required: - any description: Array of stages for manual review required: - stages required: - type - params required: - rules - defaultEvent description: Masking exception review flow for the data product. suspended: type: boolean description: Whether access to the data product's data sources is suspended example: false CreateAccessRequest: type: object properties: user: type: string format: uuid description: Immuta global user ID of the user for whom access is being requested form: description: The request form submission required: - user PaginatedAccessRequest: type: object properties: data: type: array items: type: object properties: id: type: string format: cuid requestingUser: type: object properties: id: type: number iamId: type: string description: ID of the IAM the user is associated with globalUserId: type: string format: uuid description: Immuta global user ID username: type: string description: Username/login name for the user name: type: string description: Display name email: type: - string - 'null' description: Email address authorizations: type: object additionalProperties: type: array items: type: string required: - id - iamId - globalUserId - username - name title: Immuta User user: type: object properties: id: type: number iamId: type: string description: ID of the IAM the user is associated with globalUserId: type: string format: uuid description: Immuta global user ID username: type: string description: Username/login name for the user name: type: string description: Display name email: type: - string - 'null' description: Email address authorizations: type: object additionalProperties: type: array items: type: string required: - id - iamId - globalUserId - username - name title: Immuta User formVersion: type: string form: description: The request form submission type: type: string enum: - DATA_ACCESS - MASKING_EXCEPTION example: DATA_ACCESS metadata: description: Metadata associated with the access request status: type: string enum: - APPROVED - CANCELED - DENIED - PENDING - NONE - PUBLISHER - REVOKED - EXPIRED example: PENDING expiration: type: string format: date-time description: When the temporary access will expire createdAt: type: string format: date-time updatedAt: type: string format: date-time dataProduct: type: object properties: id: oneOf: - type: string format: cuid - type: string format: uuid name: type: string minLength: 1 maxLength: 255 pattern: ^[\p{L}\p{M}\p{N})(\-_/\\\s]*$ description: Data product name description: oneOf: - type: string description: Data product description example: All sales records from the current fiscal year description: Data product description required: - id - name asset: type: object properties: id: oneOf: - type: string format: cuid - type: string format: uuid type: type: string enum: - DATA_OBJECT name: type: string minLength: 1 description: Asset name metadata: type: object properties: subjectMatterExperts: default: [] type: array items: type: object properties: id: type: string format: uuid description: Immuta global user ID of the subject matter expert username: type: string name: type: string required: - id objectPath: type: array items: type: string technology: type: string enum: - Snowflake - PostgreSQL - Databricks - Glue - MySQL - Teradata - MariaDB - Oracle - SQLServer - Trino - Redshift - BigQuery host: type: string port: type: integer minimum: 1 maximum: 65535 legacyType: type: string dataSourceId: type: number description: oneOf: - type: string externalLink: oneOf: - type: string required: - objectPath description: Data object asset metadata required: - id - type - name - metadata required: - id - requestingUser - user - formVersion - type - status - createdAt - updatedAt title: Hydrated Access Request description: Access request with user and data product metadata meta: type: object properties: offset: default: 0 type: number minimum: 0 limit: default: 10 type: number minimum: 1 totalCount: type: number pageCount: type: number currentPage: type: number totalPages: type: number required: - totalCount - pageCount - currentPage - totalPages required: - data - meta AllDataSources: type: object properties: dataSources: type: array items: type: object properties: sourceId: type: string required: - sourceId required: - dataSources UpdateDataSources: type: object properties: dataSources: type: array items: type: object properties: sourceId: type: string required: - sourceId required: - dataSources securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http externalDocs: description: Find out more about Immuta url: https://documentation.immuta.com/SaaS/