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.
| Attribute | Description |
|---|---|
| Method | Endpoint | Description |
|---|---|---|
POST /collectionCreate 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.
Returns a domains object.
GET /collectionRetrieve domains created in Immuta. These results can be filtered by permission or by name.
The following table describes optional query parameters for retrieving domains.
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}Retrieve a domain with the given collectionId to view the data sources, description, and assigned permissions associated with the domain.
Returns a domains object.
GET /collection/{collectionType}/{collectionName}Retrieve a domain with the given collectionName to view the data sources, description, and assigned permissions associated with the domain.
Returns a domains object.
PUT /collection/{collectionId}Change the domain name or description. You must have the global GOVERNANCE permission to update the domain.
Path parameter
Body parameters
Returns a domains object with the new name or description.
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.
Path parameter
Query parameter
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}/datasourcesAdd existing data sources to a domain. You must have the GOVERNANCE permission.
The request will fail if any data source IDs that have already been assigned to a domain are included in the payload.
Path parameter
Body parameter
Returns a unique identifier of the background job that adds the data sources to the domain.
GET /collection/{collectionId}/datasourcesRetrieve the data sources within a domain.
Path parameter
Query parameters
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}Remove data sources from a domain. To remove data sources from a domain, you must have the global CREATE_DATA_SOURCE permission.
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}/permissionsAssign domain permissions to a specific user. You must have the global USER_ADMIN permission to assign domain permissions to users.
Path parameter
Body parameters
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}Retrieve a list of permissions associated with the domain.
Path parameter
Query parameters
Returns a data property that contains an array of users or groups who have been assigned that permission in the domain.
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.
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}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.
Returns a 204 code when the permission is successfully removed. Additional responses are provided below:
400: Invalid permission
404: Collection or permission not found
| Parameter | Description | Required or Optional | Default values | Accepted values |
|---|---|---|---|---|
| Parameter | Description | Accepted values |
|---|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description | Required or Optional | Default values | Accepted values |
|---|---|---|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description | Required or Optional | Default values | Accepted values |
|---|---|---|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description | Accepted values |
|---|---|---|
| Parameter | Description |
|---|---|
| Attribute | Description |
|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description | Required or Optional | Default values | Accepted values |
|---|---|---|---|---|
| Parameter | Description |
|---|---|
| Parameter | Description | Accepted values |
|---|---|---|
| Parameter | Description |
|---|---|
| Parameter | 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.
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.
type string
The type of collection. Value is domain.
POST
Creates a new domain
GET
Retrieves all domains
GET
Retrieves a specific domain
GET
Retrieves a specific domain by name
PUT
Updates a domain name or description
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
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.
id string
The unique identifier of the domain.
Required
-
-
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 collection.
Required
domain
domain
type string
The type of collection.
domain
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.
Minimum value is 0. Maximum value is the total number of domains minus size.
size integer
The number of domains to return.
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.
-
withPermissions string
Only returns domains that the querying user has been granted the permission in.
Manage Policies
collectionId string
The unique identifier of the domain.
collectionType string
The type of collection. The accepted value is domain.
collectionName string
The name of the domain.
collectionId string
The unique identifier of the domain.
name string
The name of the domain.
Optional
-
-
description string
The description of the domain that will be displayed for users.
Optional
-
-
collectionId string
The unique identifier of the domain.
dryRun boolean
If true, the domain will not be deleted.
collectionId string
The unique identifier of the domain.
dataSourceId integer
The unique identifier of the data source in Immuta.
Required
-
-
collectionId string
The unique identifier of the domain.
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.
collectionId 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.
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.
collectionId string
The unique identifier of the domain.
permission string
The permission assigned to the user. Accepted value is Manage Policies.
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.
collectionId string
The unique identifier of the domain.
groupId integer
The unique identifier of the group the permission is assigned to.
Optional
[]
-
profileId integer
The unique identifier of the user in the identity manager.
Optional
[]
-
permission string
The domain permission assigned to the user.
Required
-
Manage Policies
collectionId 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.
type string
The permission to return.
Manage Policies
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.
collectionId
name
profileId
sortOrder string
Specifies how to sort the results of the request.
asc
desc
collectionId string
The unique identifier of the domain.
permissionId string
The unique identifier of the assigned permission.
collectionId string
The unique identifier of the domain.
memberType string
The type of member to remove the permission from. Possible values include user or group.
memberId number
The unique identifier of the user or group.
permissionType string
The type of permission to delete. Accepted value is Manage Policies.