LogoLogo
SaaS
  • Immuta Documentation - SaaS
  • Configuration
    • Connect Data Platforms
      • Data Platforms Overview
      • Amazon S3 Integration
      • AWS Lake Formation
        • Getting Started with AWS Lake Formation
        • Register an AWS Lake Formation Connection
        • Reference Guides
          • AWS Lake Formation
          • Security and Compliance
          • Protecting Data
          • Accessing Data
      • Azure Synapse Analytics
        • Getting Started with Azure Synapse Analytics
        • Configure Azure Synapse Analytics Integration
        • Reference Guides
          • Azure Synapse Analytics Overview
          • Azure Synapse Analytics Pre-Configuration Details
      • Databricks
        • Databricks Spark
          • Getting Started with Databricks Spark
          • How-to Guides
            • Configure a Databricks Spark Integration
            • Manually Update Your Databricks Cluster
            • Install a Trusted Library
            • Project UDFs Cache Settings
            • Run R and Scala spark-submit Jobs on Databricks
            • DBFS Access
            • Troubleshooting
          • Reference Guides
            • Databricks Spark Integration Configuration
              • Installation and Compliance
              • Customizing the Integration
              • Setting Up Users
              • Spark Environment Variables
              • Ephemeral Overrides
            • Security and Compliance
            • Registering and Protecting Data
            • Accessing Data
              • Delta Lake API
        • Databricks Unity Catalog
          • Getting Started with Databricks Unity Catalog
          • How-to Guides
            • Configure a Databricks Unity Catalog Integration
            • Migrating to Unity Catalog
          • Databricks Unity Catalog Integration Reference Guide
      • Google BigQuery Integration
      • Redshift
        • Getting Started with Redshift
        • How-to Guides
          • Configure Redshift Integration
          • Configure Redshift Spectrum
        • Reference Guides
          • Redshift Overview
          • Redshift Pre-Configuration Details
      • Snowflake
        • Getting Started with Snowflake
        • How-to Guides
          • Configure a Snowflake Integration
          • Edit or Remove Your Snowflake Integration
          • Integration Settings
            • Snowflake Table Grants Private Preview Migration
            • Enable Snowflake Table Grants
            • Using Snowflake Data Sharing with Immuta
            • Enable Snowflake Low Row Access Policy Mode
              • Upgrade Snowflake Low Row Access Policy Mode
            • Configure Snowflake Lineage Tag Propagation
        • Reference Guides
          • Snowflake Integration
          • Snowflake Table Grants
          • Snowflake Data Sharing with Immuta
          • Snowflake Low Row Access Policy Mode
          • Snowflake Lineage Tag Propagation
          • Warehouse Sizing Recommendations
        • Explanatory Guides
          • Phased Snowflake Onboarding
      • Starburst (Trino)
        • Getting Started with Starburst (Trino)
        • How-to Guides
          • Configure Starburst (Trino) Integration
          • Customize Read and Write Access Policies for Starburst (Trino)
        • Starburst (Trino) Integration Reference Guide
      • Queries Immuta Runs in Your Data Platform
      • Connect Your Data
        • Registering a Connection
          • How-to Guides
            • Register a Snowflake Connection
            • Register a Databricks Unity Catalog Connection
            • Manually Run Object Sync
            • Manage Connection Settings
            • Use the Connection Upgrade Manager
              • Troubleshooting
          • Reference Guides
            • Connections
            • Upgrading to Connections
              • Before You Begin
              • API Changes
              • FAQ
        • Registering Metadata
          • Data Sources in Immuta
          • Register Data Sources
            • Amazon S3 Data Source
            • Azure Synapse Analytics Data Source
            • Databricks Data Source
            • Google BigQuery Data Source
            • Redshift Data Source
            • Snowflake Data Source
              • Bulk Create Snowflake Data Sources
            • Create a Starburst (Trino) Data Source
          • Data Source Settings
            • How-to Guides
              • Manage Data Source Settings
              • Manage Data Source Members
              • Manage Access Requests and Tasks
              • Manage Data Dictionary Descriptions
              • Disable Immuta from Sampling Raw Data
            • Data Source Health Checks Reference Guide
          • Schema Monitoring
            • How-to Guides
              • Manage Schema Monitoring
              • Run Schema Monitoring and Column Detection Jobs
            • Reference Guides
              • Schema Monitoring
              • Schema Projects
            • Why Use Schema Monitoring Concept Guide
    • Manage Data Metadata
      • Connect External Catalogs
        • Configure an External Catalog
        • Reference Guides
          • External Catalog Introduction
          • Custom REST Catalog Interface Introduction
          • Custom REST Catalog Interface Endpoints
      • Data Discovery
        • Introduction
        • Getting Started with Data Discovery
        • How-to Guides
          • Use Identifiers in Domains
          • Use Sensitive Data Discovery (SDD)
          • Manage Identification Frameworks
          • Manage Identifiers
          • Run and Manage Sensitive Data Discovery on Data Sources
        • Reference Guides
          • Identifiers in Domains
          • Built-in Identifier Reference
          • Improved Pack: Built-in Identifier Reference
          • Built-in Discovered Tags Reference
          • How Competitive Pattern Analysis Works
      • Data Classification
        • How-to Guides
          • Activate Classification Frameworks
          • Adjust Identification and Classification Framework Tags
          • How to Use a Classification Framework with Your Own Tags
        • Reference Guide
          • Classification Frameworks
      • Manage Tags
        • How-to Guides
          • Create and Manage Tags
          • Add Tags to Data Sources and Projects
        • Tags Reference Guide
    • Manage Users
      • Getting Started with Users
      • Identity Managers (IAMs)
        • How-to Guides
          • Okta LDAP Interface
          • OpenID Connect
            • OpenID Connect Protocol
            • Okta and OpenID Connect
            • OneLogin with OpenID Connect
          • SAML
            • SAML Protocol
            • Microsoft Entra ID
            • Okta SAML SCIM
        • Reference Guides
          • Identity Managers
          • SAML Protocol Configuration Options
          • SAML Single Logout
      • Immuta Users
        • How-to Guides
          • Managing Personas and Permissions
          • User Impersonation
          • Manage Attributes and Groups
          • External User ID Mapping
          • External User Info Endpoint
        • Reference Guides
          • Permissions and Personas
          • Attributes and Groups in Immuta
    • Organize Data into Domains
      • Getting Started with Domains
      • Domains Reference Guide
    • Application Settings
      • How-to Guides
        • App Settings
        • Private Networking Support
          • Data Connection Private Networking
            • AWS PrivateLink for Redshift
            • AWS PrivateLink for API Gateway
            • Databricks Private Connectivity
              • AWS PrivateLink for Databricks
              • Azure Private Link for Databricks
            • Snowflake Private Connectivity
              • AWS PrivateLink for Snowflake
              • Azure Private Link for Snowflake
            • Starburst (Trino) Private Connectivity
              • AWS PrivateLink for Starburst (Trino)
              • Azure Private Link for Starburst (Trino)
          • Immuta SaaS Private Networking
            • Immuta SaaS Private Networking Over AWS PrivateLink
        • BI Tools
          • BI Tool Configuration Recommendations
          • Power BI Configuration Example
          • Tableau Configuration Example
        • IP Filtering
        • System Status Bundle
      • Reference Guides
        • Deployment Options
        • Data Processing
        • Encryption and Masking Practices
  • Marketplace
    • Introduction
      • User Types
      • Walkthrough
    • Share Data Products
      • How-to Guides
        • Manage Data Products
        • View and Respond to Access Requests
        • Customize the Marketplace Branding
      • Reference Guides
        • Marketplace App Requirements
        • Data Products
        • Marketplace Permissions Matrix
        • Understanding Access Provisioning and Underlying Policies in Immuta
          • S3 Provisioning Best Practices
        • Integrating with Existing Catalogs
        • Setting Up Domains for Marketplace
    • Access Data Products
      • How-to Guides
        • Logging into Marketplace
        • Requesting Access to a Data Product
      • Reference Guide
        • Data Source Access Status
    • Short-Term Limitations
  • Governance
    • Introduction
      • Automate Data Access Control Decisions
        • The Two Paths
        • Managing User Metadata
        • Managing Data Metadata
        • Author Policy
        • Test and Deploy Policy
      • Compliantly Open More Sensitive Data for ML and Analytics
        • Managing User Metadata
        • Managing Data Metadata
        • Author Policy
    • Author Policies for Data Access Control
      • Introduction
        • Scalability and Evolvability
        • Understandability
        • Distributed Stewardship
        • Consistency
        • Availability of Data
      • Policies
        • Authoring Policies at Scale
        • Data Engineering with Limited Policy Downtime
        • Subscription Policies
          • Overview
          • How-to Guides
            • Author a Subscription Policy
            • Author an ABAC Subscription Policy
            • Subscription Policies Advanced DSL Guide
            • Author a Restricted Subscription Policy
            • Clone, Activate, or Stage a Global Policy
          • Reference Guides
            • Subscription Policy Access Types
            • Advanced Use of Special Functions
        • Data Policies
          • Overview
          • How-to Guides
            • Author a Masking Data Policy
            • Author a Minimization Policy
            • Author a Purpose-Based Restriction Policy
            • Author a Restricted Data Policy
            • Author a Row-Level Policy
            • Author a Time-Based Restriction Policy
            • Policy Certifications and Diffs
          • Reference Guides
            • Data Policy Types
            • Masking Policies
            • Row-Level Policies
            • Custom WHERE Clause Functions
            • Data Policy Conflicts and Fallback
            • Custom Data Policy Certifications
            • Orchestrated Masking Policies
      • Projects and Purpose-Based Access Control
        • Projects and Purpose Controls
          • Getting Started
          • How-to Guides
            • Create a Project
            • Create and Manage Purposes
            • Adjust a Policy
            • Project Management
              • Manage Projects and Project Settings
              • Manage Project Data Sources
              • Manage Project Members
          • Reference Guides
            • Projects and Purposes
            • Policy Adjustments
          • Concept Guide
            • Why Use Purposes?
        • Equalized Access
          • Manage Project Equalization How-to Guide
          • Equalized Access Reference Guide
          • Why Use Project Equalization?
        • Masked Joins
          • Enable Masked Joins How-to Guide
          • Why Use Masked Joins?
        • Writing to Projects
          • How-to Guides
            • Create and Manage Snowflake Project Workspaces
            • Create and Manage Databricks Spark Project Workspaces
            • Write Data to the Workspace
          • Reference Guides
            • Writing to Projects
            • Project UDFs (Databricks)
      • Data Consumers
        • Subscribe to a Data Source
        • Query Data
          • Querying Snowflake Data
          • Querying Databricks Data
          • Querying Starburst (Trino) Data
          • Querying Databricks SQL Data
          • Querying Redshift Data
          • Querying Azure Synapse Analytics Data
        • Subscribe to Projects
    • Observe Access and Activity
      • Introduction
      • Audit
        • How-to Guides
          • Export Audit Logs to S3
          • Export Audit Logs to ADLS
          • Use Immuta Audit
          • Run Governance Reports
        • Reference Guides
          • Universal Audit Model (UAM)
            • UAM Schema Reference Guide
          • Query Audit Logs
            • Snowflake Query Audit Logs
            • Databricks Unity Catalog Query Audit Logs
            • Databricks Spark Query Audit Logs
            • Starburst (Trino) Query Audit Logs
          • Audit Export GraphQL Reference Guide
          • Unknown Users in Audit Logs
          • Governance Report Types
        • Deprecated Audit Guides
          • Legacy to UAM Migration
          • Manage Audit Logs
      • Dashboards
        • Use the Audit Dashboards How-To Guide
        • Audit Dashboards Reference Guide
      • Monitors
        • Manage Monitors and Observations
        • Monitors Reference Guide
  • Releases
    • Deployment Notes
      • 2024
      • 2023
      • 2022
    • Scheduled Maintenance Windows
    • Immuta Support Matrix Overview
    • Immuta CLI Release Notes
    • Preview Features
      • Features in Preview
    • Deprecations
  • Developer Guides
    • The Immuta CLI
      • Install and Configure the Immuta CLI
      • Manage Your Immuta Tenant
      • Manage Data Sources
      • Manage Sensitive Data Discovery
        • Manage Sensitive Data Discovery Rules
        • Manage Identification Frameworks
        • Run Sensitive Data Discovery on Data Sources
      • Manage Policies
      • Manage Projects
      • Manage Purposes
      • Manage Audit Export
    • The Immuta API
      • Integrations API
        • Getting Started
        • How-to Guides
          • Configure an Amazon S3 Integration
          • Configure an Azure Synapse Analytics Integration
          • Configure a Databricks Unity Catalog Integration
          • Configure a Google BigQuery Integration
          • Configure a Redshift Integration
          • Configure a Snowflake Integration
          • Configure a Starburst (Trino) Integration
        • Reference Guides
          • Integrations API Endpoints
          • Integration Configuration Payload
          • Response Schema
          • HTTP Status Codes and Error Messages
      • Connections API
        • How-to Guides
          • Register a Connection
            • Register a Snowflake Connection
            • Register a Databricks Unity Catalog Connection
            • Register an AWS Lake Formation Connection
          • Manage a Connection
          • Deregister a Connection
        • Connection Registration Payloads Reference Guide
      • Marketplace API
        • Marketplace API Endpoints
        • Source Controlling Data Products
      • Immuta V2 API
        • Data Source Payload Attribute Details
          • Data Source Request Payload Examples
        • Create Policies API Examples
        • Create Projects API Examples
        • Create Purposes API Examples
      • Immuta V1 API
        • Authenticate with the API
        • Configure Your Instance of Immuta
          • Get Job Status
          • Manage Frameworks
          • Manage IAMs
          • Manage Licenses
          • Manage Notifications
          • Manage Sensitive Data Discovery (SDD)
          • Manage Tags
          • Manage Webhooks
          • Search Filters
        • Connect Your Data
          • Create and Manage an Amazon S3 Data Source
          • Create an Azure Synapse Analytics Data Source
          • Create a Databricks Data Source
          • Create a Redshift Data Source
          • Create a Snowflake Data Source
          • Create a Starburst (Trino) Data Source
          • Manage the Data Dictionary
        • Use Domains
        • Manage Data Access
          • Manage Access Requests
          • Manage Data and Subscription Policies
          • Manage Write Policies
            • Write Policies Payloads and Response Schema Reference Guide
          • Policy Handler Objects
          • Search Audit Logs
          • Search Connection Strings
          • Search for Organizations
          • Search Schemas
        • Subscribe to and Manage Data Sources
        • Manage Projects and Purposes
          • Manage Projects
          • Manage Purposes
        • Generate Governance Reports
Powered by GitBook

Self-managed versions

  • 2024.3
  • 2024.2

Resources

  • Immuta Changelog

Copyright © 2014-2025 Immuta Inc. All rights reserved.

On this page
  • Endpoints and methods
  • POST /domain
  • Body parameters
  • Response
  • GET /domain
  • Query parameters
  • Response
  • GET /domain/{domainId}
  • Path parameter
  • Response
  • GET /domain/{domainId}/allPermissions
  • Path parameter
  • Query parameters
  • Response
  • GET /domain/name/{domainName}
  • Path parameter
  • Response
  • PUT /domain/{domainId}
  • Path parameter
  • Body parameters
  • Response
  • POST /domain/{domainId}/assignment
  • Path parameter
  • Body parameters
  • Response
  • PUT /domain/{domainId}/settings
  • Path parameter
  • Body parameter
  • Response
  • DELETE /domain/{domainId}
  • Path parameter
  • Query parameter
  • Response
  • POST /domain/{domainId}/datasources
  • Path parameter
  • Body parameter
  • Response
  • GET /domain/{domainId}/datasources
  • Path parameter
  • Query parameters
  • Response
  • DELETE /domain/{domainId}/datasources/{dataSourceId}
  • Path parameters
  • Response
  • POST /domain/{domainId}/permissions
  • Path parameter
  • Body parameters
  • Response
  • POST /domain/{domainId}/permissions/bulk-delete
  • Path parameter
  • Body parameters
  • Response
  • GET /domain/{domainId}/permissions/{memberType}
  • Path parameters
  • Query parameters
  • Response
  • GET /domain/permissions/{memberType}/{memberId}
  • Path parameters
  • Query parameters
  • Response
  • DELETE /domain/{domainId}/permissions/{permissionId}
  • Path parameters
  • Response
  • DELETE /domain/{domainId}/permissions/{memberType}/{memberId}/{permissionType}
  • Path parameters
  • Response
  • Domain object attributes
  • Domains permissions object attributes

Was this helpful?

Export as PDF
  1. Developer Guides
  2. The Immuta API
  3. Immuta V1 API

Use Domains

Domains API reference guide

Endpoint changes

The /domain endpoint was previously the /collections endpoint. Currently, the /collections endpoint will continue to work; however, work with your Immuta representative to migrate any automated jobs over to the /domain endpoint.

The domains API allows users to create domains and organize data sources into them.

Endpoints and methods

Method
Endpoint
Description

POST

Creates a new domain

GET

Retrieves all domains

GET

Retrieves a specific domain

GET

Retrieves all permission IDs for a specific domain

GET

Retrieves a specific domain by name

PUT

Updates a domain name or description

POST

Updates the domain data source assignment type

PUT

Updates the domain's settings

DELETE

Deletes a domain

POST

Adds data sources to a domain

GET

Retrieves the data sources in the domain

DELETE

Deletes a data source from a domain

POST

Assigns a domain permission to a user

POST

Deletes multiple permissions from a domain

GET

Retrieves user permissions assigned in the domain

DELETE

Removes a domain permission from a user by the permission ID

DELETE

Removes a domain permission from a user by the user ID and permission type

GET

Retrieve a list of permissions for the specified user or group across all domains they are a member of

POST /domain

Required Immuta permission: GOVERNANCE

curl -X 'POST' \
    'https://your.immuta.url.com/domain' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 09a0ffd7512f4aeeb66c09f3111c436c' \
    -d '{
    "name": "Research",
    "description": "This domain is for research team data.",
    "type": "domain",
    "collectionPermissions": [
    {
      "profileId":99,
      "permission":"Manage Policies"
    },{
      "groupId":4,
      "permission":"Manage Policies"
    }],
    "collectionDataSources": [
    {
      "dataSourceId": 437
    },{
      "dataSourceId": 417
    }]
    }'

Body parameters

Parameter
Description
Required or optional
Default values
Accepted values

id string

The unique identifier of the domain.

Optional

-

-

name string

The name of the domain.

Required

-

-

description string

The description of the domain that will be displayed for users.

Optional

-

-

type string

The type of domain.

Required

-

domain

collectionPermissions array

The users or groups to grant domain-specific permissions to.

Optional

[]

-

collectionPermissions.profileId integer

The profile ID of a single user to grant domain-specific permissions to.

Optional

-

-

collectionPermissions.groupId integer

The group ID of a group to grant domain-specific permissions to.

Optional

-

-

collectionPermissions.permission string

The domain-specific permission to grant to the user or group.

Required if including domainPermissions.profileId or domainPermissions.profileId

-

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

collectionDataSources array

The data sources to add to the domain.

Optional

[]

-

collectionDataSources.dataSourceId integer

The data source ID of the data source to add to the domain.

Optional

-

-

Response

{
  "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
  "name": "Research",
  "description": "This domain is for research team data.",
  "type": "domain",
  "settings": {
    "autoscanning": false
    },
  "createdAt": "2023-05-10T14:55:29.289Z",
  "updatedAt": "2023-05-10T14:55:29.289Z",
  "createdBy": 2,
  "profile": {
    "name": "Example User"
  },
  "tags": [],
  "assignmentType": "manual"
}

GET /domain

Retrieve domains created in Immuta. These results can be filtered by permission or by name.

curl -X 'GET' \
    'https://your.immuta.url.com/domain&offset=0&size=10' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'

Query parameters

Parameter
Description
Required or optional
Accepted values

offset integer

The number of items from the beginning of the response to exclude. You can combine the offset and size parameters to return a specific set of domains. For example, to return the second and third domain in the response, you would set offset=1 and size=2.

Optional

Minimum value is 0. Maximum value is the total number of domains minus size.

size integer

The number of domains to return.

Optional

Minimum value is 1. Maximum value is the total number of domains.

searchText string

The text to search for in domain names. This will return domains with a name that contains this search text.

Optional

-

withPermissions string

Only returns domains that the querying user has been granted the permission in.

Optional

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

isExactMatch boolean

If true, will only return domains with the exact name.

Optional

true or false

isDomainPolicySearch boolean

If true, will only return domains that the user can modify policies on.

Optional

true or false

Response

{
  "data": [{
    "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
    "name": "Marketing domain",
    "description": "This is a domain of marketing data.",
    "type": "domain",
    "createdAt": "2023-05-10T14:55:29.289Z",
    "updatedAt": "2023-05-10T14:55:29.289Z",
    "createdBy": 2,
    "profile": {
      "name": "Example User"
      },
    "tags": [
      {
        "name": "Marketing data",
        "displayName": "Marketing data",
        "id": 116
      }
    ],
    "assignmentType": "automatic",
    "settings": {
      "autoscanning": false
    }
  }]
}

GET /domain/{domainId}

Retrieve a domain with the given domainId to view the data sources, description, and assigned permissions associated with the domain.

curl -X 'GET' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Response

{
  "data": [{
    "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
    "name": "Marketing domain",
    "description": "This is a domain of marketing data.",
    "type": "domain",
    "createdAt": "2023-05-10T14:55:29.289Z",
    "updatedAt": "2023-05-10T14:55:29.289Z",
    "createdBy": 2,
    "profile": {
      "name": "Example User"
      },
    "tags": [
      {
        "name": "Marketing data",
        "displayName": "Marketing data",
        "id": 116
      }
    ],
    "assignmentType": "automatic",
    "settings": {
      "autoscanning": false
    }
  }]
}

GET /domain/{domainId}/allPermissions

Retrieve all permissions assigned to the specified domain.

curl -X 'GET' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/allPermissions' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Query parameters

Parameter
Description
Accepted values

type string

The type of permission to return.

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

offset integer

The number of items from the beginning of the response to exclude. You can combine the offset and size parameters to return a specific set of permissions. For example, to return the second and third permissions in the response, you would set offset=1 and size=2.

Minimum value is 0. Maximum value is the total number of domains minus size.

size integer

The number of permissions to return.

Minimum value is 1. Maximum value is the total number of domains.

Response

{
  "data": [
    {
      "id": "3bafcd54-a18d-406d-a514-cb8a38586b7d",
      "name": "Taylor",
      "profileId": 2,
      "domainId": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
      "groupId": null,
      "permission": "Manage Policies",
      "createdAt": "2024-05-17T17:25:46.581Z"
    }
  ],
  "total": 1
}

GET /domain/name/{domainName}

Retrieve a domain with the given domainName to view the data sources, description, and assigned permissions associated with the domain.

curl -X 'GET' \
    'https://your.immuta.url.com/domain/name/Research' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'

Path parameter

Parameter
Description

domainName string

The name of the domain.

Response

{
  "data": [{
    "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
    "name": "Marketing domain",
    "description": "This is a domain of marketing data.",
    "type": "domain",
    "createdAt": "2023-05-10T14:55:29.289Z",
    "updatedAt": "2023-05-10T14:55:29.289Z",
    "createdBy": 2,
    "profile": {
      "name": "Example User"
      },
    "tags": [
      {
        "name": "Marketing data",
        "displayName": "Marketing data",
        "id": 116
      }
    ],
    "assignmentType": "automatic",
    "settings": {
      "autoscanning": false
    }
  }]
}

PUT /domain/{domainId}

Change the domain name or description.

Required Immuta permission: GOVERNANCE

curl -X 'PUT' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \
    -d '{
    "name": "HR Research",
    "description": "This domain is specifically for human resources data and research."
    }'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Body parameters

Parameter
Description
Required or optional
Default values
Accepted values

name string

The name of the domain.

Optional

-

-

description string

The description of the domain that will be displayed for users.

Optional

-

-

Response

{
  "data": [{
    "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
    "name": "HR Research",
    "description": "This domain is specifically for human resources data and research.",
    "type": "domain",
    "createdAt": "2023-05-10T14:55:29.289Z",
    "updatedAt": "2023-05-10T14:55:29.289Z",
    "createdBy": 2,
    "profile": {
      "name": "Example User"
      },
    "tags": [
      {
        "name": "Marketing data",
        "displayName": "Marketing data",
        "id": 116
      }
    ],
    "assignmentType": "automatic",
    "settings": {
      "autoscanning": false
    }
  }]
}

POST /domain/{domainId}/assignment

Change the data source assignment of the domain.

Required Immuta permission: GOVERNANCE

curl -X 'POST' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/assignment' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \
    -d '{
    "assignmentType": "dynamic",
    "tags": [{"name": "Marketing data"}]
    }'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Body parameters

Parameter
Description
Required or optional
Default values
Accepted values

assignmentType string

The way data sources will be added to the domain. If manual, data sources must be added by a user. If dynamic, include a tag and all data sources with that tag will always be in the domain.

Required

-

  • dynamic

  • manual

tags string

Details about the tag to use for dynamic assignment.

Required if assignmentType is set to dynamic

-

-

tags.name string

The name of the tag to use for dynamic assignment.

Required if assignmentType is set to dynamic

-

-

Response

Returns the number of data sources added and removed based on the domain assignment update and the new assignment type.

{
  "assignmentType": "dynamic",
  "dataSourcesAdded": 0,
  "dataSourcesKept": 0,
  "dataSourcesRemoved: 2
}

PUT /domain/{domainId}/settings

Private preview: This feature is available to select accounts. Contact your Immuta representative for details.

Change the domain's autoscanning setting.

Required Immuta permission: GOVERNANCE

curl -X 'PUT' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/settings' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \
    -d '{
    "autoscanning": true
    }'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Body parameter

Parameter
Description
Required or optional
Default values
Accepted values

autoscanning boolean

If true, autoscanning is enabled and will run sensitive data discovery automatically for all data sources added to the domain.

Optional

false

true or false

Response

Returns the new autoscanning setting.

{"autoscanning": true}

DELETE /domain/{domainId}

Delete a domain. The domain must have zero data sources, policies, and identifiers to be deleted.

Required Immuta permission: GOVERNANCE

curl -X 'DELETE' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Query parameter

Parameter
Description

dryRun boolean

If true, the domain will not be deleted.

Response

Returns a 204 code when the domain is successfully deleted. Additional responses are provided below:

  • 400: An invalid ID was provided.

  • 404: The domain was not found.

POST /domain/{domainId}/datasources

Add existing data sources to a domain. Data sources can only be added to domains with manual data source assignment.

The request will fail if any data source IDs that have already been assigned to a domain are included in the payload or if data source assignment is set to dynamic .

Required Immuta permission: GOVERNANCE

curl -X 'POST' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/datasources' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \
    -d '[
    {
      "dataSourceId": 36
    }
    ]'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Body parameter

Parameter
Description
Required or optional
Default values
Accepted values

dataSourceId integer

The unique identifier of the data source in Immuta.

Required

-

-

Response

Returns a unique identifier of the background job that adds the data sources to the domain.

{
  "jobId": "e48e15a0-ef5c-11ed-892c-a75afcd86969"
}

GET /domain/{domainId}/datasources

Retrieve the data sources within a domain.

curl -X 'GET' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/datasources?offset=0&size=10' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Query parameters

Parameter
Description
Accepted values

offset integer

The number of items from the beginning of the response to exclude. You can combine the offset and size parameters to return a specific set of data sources. For example, to return the second and third data source in the response, you would set offset=1 and size=2.

Minimum value is 0. Maximum value is the total number of data sources minus size.

size integer

The number of data sources to return.

Minimum value is 1. Maximum value is the total number of data sources.

searchText string

The text to search for in data source names. This will return data sources with a name that contains this search text.

-

dataSourceIds integer

Filters search results by data source ID.

-

Response

Returns a data property that contains an array of up to size data sources. Each entry in the array is a separate data source. If there are no data sources in the domain, the array will be empty.

{
  "data": [{
    "dataSourceId": 36,
    "createdAt": "2023-05-10T18:02:57.068Z",
    "name": "HR Data",
    "type": "queryable",
    "platform": "PostgreSQL",
    "connectionString": "immuta@your.database.host.com:5432/public",
    "schema": "public",
    "table": "research_data",
    "tags": []
    }],
  "total": 1
}

DELETE /domain/{domainId}/datasources/{dataSourceId}

Remove data sources from a domain. Data sources can only be removed from domains with manual data source assignment.

The request will fail if the data source assignment is set to dynamic .

Required Immuta permission: CREATE_DATA_SOURCE

curl -X 'DELETE' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/datasources/36' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'

Path parameters

Parameter
Description

domainId string

The unique identifier of the domain from which to remove the data source.

dataSourceId integer

The unique identifier of the data source to remove.

Response

Returns a 204 code when the data source is successfully removed from the domain. Additional responses are included below:

  • 403: Requesting user does not have permission to remove the data source.

  • 404: The specified domain or data source was not found.

POST /domain/{domainId}/permissions

Assign domain permissions to a specific user.

Required Immuta permission: USER_ADMIN

curl -X 'POST' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \
    -d '[
    {
      "profileId": 2,
      "permission": "Manage Policies"
    },
    {
      "profileId": 3,
      "permission": "Manage Policies"
    }
    ]'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Body parameters

Parameter
Description
Required or optional
Default values
Accepted values

groupId integer

The unique identifier of the group.

Optional

[]

-

profileId integer

The unique identifier of the user in the identity manager.

Optional

[]

-

permission string

The domain permission to assign to the user or group.

Required

-

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

Response

{
  "success": [
    {
      "id": "c2ec9049-ac93-4700-9e21-f0ec3a0de6bb",
      "profileId": 3,
      "domainId": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
      "permission": "Manage Policies",
      "createdAt": "2023-05-10T18:37:05.847Z"
    }
  ],
  "errors": [
    {
      "profileId": 2,
      "domainId": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
      "permission": "Manage Policies",
      "message": "Permission already exists"
    }
  ]
}

POST /domain/{domainId}/permissions/bulk-delete

Remove permissions from multiple users or groups in a domain.

Required Immuta permission: USER_ADMIN

curl -X 'POST' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/bulk-delete' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \
    -d '[
    {
      "domainPermissions": [
        {
          "profileId": 2,
          "permission": "Manage Policies"
        },
        {
          "profileId": 3,
          "permission": "Manage Policies"
        }
      ]
    }
    ]'

Path parameter

Parameter
Description

domainId string

The unique identifier of the domain.

Body parameters

Parameter
Description
Required or Optional
Default values
Accepted values

domainPermissions.groupId integer

The unique identifier of the group the permission is assigned to.

Required if profileId is not provided

-

-

domainPermissions.profileId integer

The unique identifier of the user the permission is assigned to.

Required if groupId is not provided

-

-

domainPermissions.permission string

The domain permission assigned to the user or group.

Required

-

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

Response

{
  "success": [
    "d6378973-e15d-4310-8f1e-671c6b08e6a2",
    "83e6cb4a-4f41-47b4-b455-16fe518d5068"
  ],
  "errors": []
}

GET /domain/{domainId}/permissions/{memberType}

Retrieve a list of permissions associated with the domain.

curl -X 'GET' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/user?offset=0&size=10' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'

Path parameters

Parameter
Description

domainId string

The unique identifier of the domain.

memberType string

The type of member to get a list of permissions for. Possible values include user or group.

Query parameters

Parameter
Description
Accepted values

type string

The permission to return.

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

offset integer

The number of items from the beginning of the response to exclude. You can combine the offset and size parameters to return a specific set of domain users. For example, to return the second and third domain users in the response, you would set offset=1 and size=2.

Minimum value is 0. Maximum value is the total number of domain users minus size.

size integer

The number of users to return.

Minimum value is 1. Maximum value is the total number of domain users.

searchText string

A string used to filter the results returned by the name.

-

sortField string

Specifies the field to sort the results by.

  • domainId

  • name

  • profileId

sortOrder string

Specifies how to sort the results of the request.

  • asc

  • desc

Response

Returns a data property that contains an array of users or groups who have been assigned that permission in the domain.

{
  "data": [{
    "id": "1bf5fa36-8130-4f72-8f4f-d1f18c25c2a2",
    "name": "Example User",
    "profileId": 2,
    "domainId": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
    "permission": "Manage Policies",
    "source": [
      "User Permission(s)"
    ]
    },
    {
    "id": "6172d495-c560-4ae1-bceb-cc6ce15e55ec",
    "name": "Example User 2",
    "profileId": 3,
    "domainId": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
    "permission": "Manage Policies",
    "source": [
      "User Permission(s)"
    ]
    }],
  "total": 2
}

GET /domain/permissions/{memberType}/{memberId}

Retrieve a list of permissions for the specified user or group across all domains they are a member of.

curl -X 'GET' \
    'https://your.immuta.url.com/domain/permissions/user/2?offset=0&size=10' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'

Path parameters

Parameter
Description

memberType string

The type of member to get a list of permissions for. Possible values include user or group.

memberId string

The unique identifier of the user or group.

Query parameters

Parameter
Description
Accepted values

type string

The permission to return.

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

offset integer

The number of items from the beginning of the response to exclude. You can combine the offset and size parameters to return a specific set of domain permissions. For example, to return the second and third permission in the response, you would set offset=1 and size=2.

Minimum value is 0. Maximum value is the total number of domain permissions that user or group has minus size.

size integer

The number of permissions to return.

Minimum value is 1. Maximum value is the total number of domain permissions that user or group has.

searchText string

A string used to filter the results returned by the name.

-

sortField string

Specifies the field to sort the results by.

  • domainId

  • name

  • profileId

sortOrder string

Specifies how to sort the results of the request.

  • asc

  • desc

Response

Returns a data property that contains an array of permissions that have been assigned to the user or group in all the domains they are a member of.

{
  "data": [{
    "profileId": 2,
    "name": "Taylor",
    "domainId": "c7458ee9-03e5-4b6f-8395-ad4e49235428",
    "domainName": "Marketing domain",
    "permission": "Manage Policies",
    "source": [
      "User Permission(s)"
    ],
    "userObjectId": 2,
    "iamId": "bim"
    },
    {
    "profileId": 2,
    "name": "Taylor",
    "domainId": "a5678ef9-53e5-4b6f-8395-aa4e49237689",
    "domainName": "Customer support domain",
    "permission": "Manage Policies",
    "source": [
      "User Permission(s)"
    ],
    "userObjectId": 2,
    "iamId": "bim"
    }
    ]
}

DELETE /domain/{domainId}/permissions/{permissionId}

Remove a domain permission from a specific user or group.

Required Immuta permission: USER_ADMIN

curl -X 'DELETE' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/c2ec9049-ac93-4700-9e21-f0ec3a0de6bb' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'

Path parameters

Parameter
Description

domainId string

The unique identifier of the domain.

permissionId string

The unique identifier of the assigned permission.

Response

Returns a 204 code when the permission is successfully removed from the user. Additional responses are provided below:

  • 400: Invalid permission

  • 404: Domain or permission not found

DELETE /domain/{domainId}/permissions/{memberType}/{memberId}/{permissionType}

Remove a domain permission based on the permission type.

Required Immuta permission: USER_ADMIN

curl -X 'DELETE' \
    'https://your.immuta.url.com/domain/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/user/2/Manage%20Policies' \
    -H 'accept: application/json' \
    -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'

Path parameters

Parameter
Description
Accepted values

domainId string

The unique identifier of the domain.

-

memberType string

The type of member to remove the permission from.

  • user

  • group

memberId number

The unique identifier of the user or group.

-

permissionType string

The type of permission to delete.

  • Manage Policies

  • Manage Data Products

  • Audit Activity

  • Manage Identifiers

Response

Returns a 204 code when the permission is successfully removed. Additional responses are provided below:

  • 400: Invalid permission

  • 404: Domain or permission not found

Domain object attributes

Attribute
Description

id string

The unique identifier of the domain.

name string

The name of the domain.

description string

The description of the domain that will be displayed for users.

settings array

The domain settings.

settings.autoscanning boolean

If true, sensitive data discovery autoscanning is on.

tags array

The tag used to dynamically assign data sources to the domain.

tags.name string

The name of the tag used to dynamically assign data sources to the domain.

tags.displayName string

The display name of the tag used to dynamically assign data sources to the domain.

tags.id integer

The ID of the tag used to dynamically assign data sources to the domain.

assignmentType string

The way data sources are assigned to the domain. Options are dynamic or manual.

createdBy integer

The unique identifier of the user who created the domain.

profile.name string

The name of the user who created the domain.

createdAt timestamp

The date and time the domain was created.

updatedAt timestamp

The date and time the domain was updated.

Domains permissions object attributes

Attribute
Description

id string

The unique identifier of the permissions object.

profileId integer

The unique identifier of the user the permission is assigned to.

groupId integer

The unique identifier of the group the permission is assigned to.

domainId string

The unique identifier of the domain.

permission string

The permission assigned to the user.

createdAt timestamp

The date and time the permission object was created.

source string

Indicates whether the permission was assigned as a user permission or a group permission.

PreviousManage the Data DictionaryNextManage Data Access

Last updated 14 days ago

Was this helpful?

Create a new domain. You can also , , and after creating the domain.

Returns a .

Returns a data property that contains an array of up to size . If no domains exist, the array will be empty.

Returns a .

Returns an array of that represent a permission in a domain assigned to a specific user.

Returns a .

Returns a with the new name or description.

Returns an array of that represent a permission in a domain assigned to a specific user. If the permission had already been assigned to the user for that domain, the response will include an error for the permissions that were not assigned to that user because the permission already existed.

Returns an array of that represent a permission in a domain deleted from that specific user or group. Response includes permissions that failed to delete.

add data sources
update user permissions
change the data source assignment
domains object
domain objects
domains object
domain permission objects
domains object
domains object
domain permission objects
domain permission objects
/domain
/domain
/domain/{domainId}
/domain/{domainId}/allPermissions
/domain/name/{domainName}
/domain/{domainId}
/domain/{domainId}/assignment
/domain/{domainId}/settings
/domain/{domainId}
/domain/{domainId}/datasources
/domain/{domainId}/datasources
/domain/{domainId}/datasources/{dataSourceId}
/domain/{domainId}/permissions
/domain/{domainId}/permissions/bulk-delete
/domain/{domainId}/permissions/{memberType}
/domain/{domainId}/permissions/{permissionId}
/domain/{domainId}/permissions/{memberType}/{memberId}/{permissionType}
/domain/permissions/{memberType}/{memberId}