openapi: 3.2.0 info: title: Immuta Data Marketplace Request Form 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: Request Form description: APIs for managing request forms paths: /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: - Request Form /api/asset/{id}/request-forms: get: description: Get the request forms assigned to the asset. operationId: getAssetRequestForms parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AssetRequestForms' security: - bearer: [] summary: Get request forms for an asset tags: - Request Form /api/request-form: post: description: Create a request form operationId: createRequestForm parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRequestForm' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/RequestForm' '409': description: Request form with name already exists. security: - bearer: [] summary: Create request form tags: - Request Form get: description: Search request forms in the marketplace using the provided filters operationId: searchRequestForms parameters: - 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: sortBy required: false in: query schema: default: name type: string enum: - name - createdAt - updatedAt - name: nameFilter required: false in: query description: Filter results by request form name schema: default: '' type: string - name: exactMatch required: false in: query description: Whether the filter should be an exact match schema: default: false type: boolean responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedRequestForm' security: - bearer: [] summary: Search request forms tags: - Request Form /api/request-form/{id}: get: description: Get request form by ID operationId: getRequestFormById parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RequestForm' security: - bearer: [] summary: Get request form by ID tags: - Request Form delete: description: Delete a request form operationId: deleteRequestFormById parameters: - name: id required: true in: path schema: type: string responses: '204': description: '' security: - bearer: [] summary: Delete request form by ID tags: - Request Form put: description: Update a request form operationId: updateRequestForm parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRequestForm' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/RequestForm' security: - bearer: [] summary: Update request form by ID tags: - Request Form /api/request-form/version/{version}: get: description: Get request form by its version operationId: getRequestFormByVersion parameters: - name: version required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RequestForm' security: - bearer: [] summary: Get request form by version tags: - Request Form /api/request-form/{id}/data-products: get: description: Get the data products assigned to the request form operationId: getDataProducts parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/LinkedDataProducts' security: - bearer: [] summary: Get data products assigned to the request form tags: - Request Form /api/request-form/{id}/assets: get: description: Get the assets assigned to the request form operationId: getAssets parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/LinkedAssets' security: - bearer: [] summary: Get assets assigned to the request form tags: - Request Form components: schemas: AssetRequestForms: type: object properties: dataAccessForm: 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 maskingExceptionForm: 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 required: - dataAccessForm LinkedDataProducts: 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 requestTypes: type: array items: type: string enum: - DATA_ACCESS - MASKING_EXCEPTION description: Request types linking this data product to the request form required: - id - name - requestTypes description: The data products linked to the request form 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 RequestForm: 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 required: - id - name - fields - policy - createdBy - createdAt - updatedBy - updatedAt - version title: Request Form UpdateRequestForm: type: object properties: 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 id: type: string format: uuid dataUseAgreementIds: type: array items: type: string format: uuid LinkedAssets: type: array items: 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_PRODUCT - DATA_OBJECT requestType: type: string enum: - DATA_ACCESS - MASKING_EXCEPTION required: - id - name - type - requestType description: The assets linked to the request form CreateRequestForm: type: object properties: 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 id: type: string format: uuid dataUseAgreementIds: type: array items: type: string format: uuid required: - name - fields - policy PaginatedRequestForm: type: object properties: data: type: array items: 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 associatedDomains: type: array items: type: string description: Domains associated with data products associated with this request form. example: - 4d004a3a-4568-4c1d-822e-30958ef898dc required: - id - name - fields - policy - createdBy - createdAt - updatedBy - updatedAt - version - associatedDomains 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 securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http externalDocs: description: Find out more about Immuta url: https://documentation.immuta.com/SaaS/