Manage Domains
Domains API reference guide
The collections object represents a domain you've created that contains data sources and assigned permissions. Currently, the only collection type available is a domain, so collections and domains are referred to interchangeably throughout this page.
Domain object attributes
Endpoints and methods
POST
/collection
POST
/collection
Create a new domain. You must have the global GOVERNANCE
permission to create a domain. You can add data sources to the domain after creating the domain.
Body parameters
Response
Returns a domains object.
GET
/collection
GET
/collection
Retrieve domains created in Immuta. These results can be filtered by permission or by name.
Query parameters
The following table describes optional query parameters for retrieving domains.
Response
Returns a data property that contains an array of up to size
domain objects. If no domains exist, the array will be empty.
GET
/collection/{collectionId}
GET
/collection/{collectionId}
Retrieve a domain with the given collectionId
to view the data sources, description, and assigned permissions associated with the domain.
Path parameter
Response
Returns a domains object.
GET
/collection/{collectionType}/{collectionName}
GET
/collection/{collectionType}/{collectionName}
Retrieve a domain with the given collectionName
to view the data sources, description, and assigned permissions associated with the domain.
Path parameter
Response
Returns a domains object.
PUT
/collection/{collectionId}
PUT
/collection/{collectionId}
Change the domain name or description. You must have the global GOVERNANCE
permission to update the domain.
Parameters
Path parameter
Body parameters
Response
Returns a domains object with the new name or description.
DELETE
/collection/{collectionId}
DELETE
/collection/{collectionId}
Delete a domain. The domain must have zero data sources for a user with the global GOVERNANCE
permission to delete the domain.
Parameters
Path parameter
Query parameter
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
/collection/{collectionId}/datasources
POST
/collection/{collectionId}/datasources
Add existing data sources to a domain. You must have the GOVERNANCE
permission.
Parameters
Path parameter
Body parameter
Response
Returns a unique identifier of the background job that adds the data sources to the domain.
GET
/collection/{collectionId}/datasources
GET
/collection/{collectionId}/datasources
Retrieve the data sources within a domain.
Parameters
Path parameter
Query parameters
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.
DELETE
/collection/{collectionId}/datasources/{dataSourceId}
DELETE
/collection/{collectionId}/datasources/{dataSourceId}
Remove data sources from a domain. To remove data sources from a domain, you must have the global CREATE_DATA_SOURCE
permission.
Path parameters
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 collection or data source was not found.
POST
/collection/{collectionId}/permissions
POST
/collection/{collectionId}/permissions
Assign domain permissions to a specific user. You must have the global USER_ADMIN
permission to assign domain permissions to users.
Domains permissions object attributes
Parameters
Path parameter
Body parameters
Response
Returns an array of domain permission objects 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.
GET
/collection/{collectionId}/permissions/{memberType}
GET
/collection/{collectionId}/permissions/{memberType}
Retrieve a list of permissions associated with the domain.
Parameters
Path parameters
Query parameters
Response
Returns a data property that contains an array of users or groups who have been assigned that permission in the domain.
GET
/collection/permissions/{memberType}/{memberId}
GET
/collection/permissions/{memberType}/{memberId}
Retrieve a list of permissions for the specified user or group across all domains they are a member of.
Parameters
Path parameters
Query parameters
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.
DELETE
/collection/{collectionId}/permissions/{permissionId}
DELETE
/collection/{collectionId}/permissions/{permissionId}
Remove a domain permission from a specific user or group. You must have the global USER_ADMIN
permission to remove domain permissions from users and groups.
Path parameters
Response
Returns a 204 code when the permission is successfully removed from the user. Additional responses are provided below:
400: Invalid permission
404: Collection or permission not found
DELETE
/collection/{collectionId}/permissions/{memberType}/{memberId}/{permissionType}
DELETE
/collection/{collectionId}/permissions/{memberType}/{memberId}/{permissionType}
Remove a domain permission based on the permission type. You must have the global USER_ADMIN
permission to remove domain permissions from users and groups.
Path parameters
Response
Returns a 204 code when the permission is successfully removed. Additional responses are provided below:
400: Invalid permission
404: Collection or permission not found
Last updated