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.
POST /collection: Creates a new domain.
GET /collection: Retrieves all domains.
GET /collection/{collectionId}: Retrieves a specific domain.
PUT /collection/{collectionId}: Updates a domain name or description.
DELETE /collection/{collectionId}: Deletes a domain.
POST /collection/{collectionId}/datasources: Adds data sources to a domain.
GET /collection/{collectionId}/datasources: Retrieves the data sources in the domain.
DELETE /collection/{collectionId}/datasources/{dataSourceId}: Deletes a data source from a domain.
POST /collection/{collectionId}/permissions: Assigns a domain permission to a user.
GET /collection/{collectionId}/permissions: Retrieves user permissions assigned in the domain.
DELETE /collection/{collectionId}/permissions/{permissionId}: Removes a domain permission from a user.
Create a new domain. Currently in preview, you cannot add data sources to the domain when creating the domain. You must have the global GOVERNANCE
permission to create a domain.
** accordion **
POST /collection
Returns a collections object.
Response
Retrieve domains created in Immuta. These results can be filtered by permission or by name.
GET /collection
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.
Response
Retrieve a domain with the given collectionId
to view the data sources, description, and assigned permissions associated with the domain.
GET /collection/{collectionId}
Returns a collections object.
Response
Change the domain name or description. You must have the global GOVERNANCE
permission to update the domain.
PUT /collection/{collectionId}
Returns a collections object with the new name or description.
Response
Delete a domain. The domain must have zero data sources for a user with the global GOVERNANCE
permission to delete the domain.
DELETE /collection/{collectionId}
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.
Add existing data sources to a domain. You must have the GOVERNANCE
permission.
POST /collection/{collectionId}/datasources
Returns a unique identifier of the background job that adds the data sources to the domain.
Response
GET /collection/{collectionId}/datasources
Retrieve the data sources within a domain.
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.
Response
Remove data sources from a domain. To remove data sources from a domain, you must have the global CREATE_DATA_SOURCE
permission.
DELETE /collection/{collectionId}/datasources/{dataSourceId}
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.
Assign domain permissions to a specific user. You must have the global USER_ADMIN
permission to assign domain permissions to users.
POST /collection/{collectionId}/permissions
Returns an array of domain permission objects that represent a permission in a domain assigned to a specific user.
Response
Retrieve a list of permissions associated with the domain.
GET /collection/{collectionId}/permissions
Returns a data property that contains an array of users who have been assigned that permission in the domain.
Response
Remove a domain permission from a specific user. You must have the global USER_ADMIN
permission to remove domain permissions from users.
DELETE /collection/{collectionId}/permissions/{permissionsId}
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.
Attribute | Data type | Description |
---|---|---|
Parameter | Data type | Description | Required or Optional | Default values | Accepted values |
---|---|---|---|---|---|
Parameter | Data type | Description | Accepted values |
---|---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description | Required or Optional | Default values | Accepted values |
---|---|---|---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description | Required or Optional | Default values | Accepted values |
---|---|---|---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description | Accepted values |
---|---|---|---|
Parameter | Data type | Description |
---|---|---|
Attribute | Data type | Description |
---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description | Required or Optional | Default values | Accepted values |
---|---|---|---|---|---|
Parameter | Data type | Description |
---|---|---|
Parameter | Data type | Description | Accepted values |
---|---|---|---|
Parameter | Data type | 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.
collectionPermissions.id
String
The unique identifier of the permission.
collectionPermissions.profileId
String
The unique identifier of the user profile in the IAM.
collectionPermissions.collectionId
String
The unique identifier of the domain for which the user has the assigned permission.
collectionPermissions.permission
String
The permission they are granted for that domain. Accepted value is Manage Policies
.
collectionDataSources.dataSourceId
Integer
The unique identifier for the data source in Immuta.
createdBy
Integer
The unique identifier of the user who created the domain.
profileId
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
.
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.
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.
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.
collectionId
String
The unique identifier of the domain.
profileId
Integer
The unique identifier of the user in the identity manager.
Required
-
-
permission
String
The domain permission assigned to the user.
Required
-
Manage Policies
collectionId
String
The unique identifier of the domain.
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.
collectionId
String
The unique identifier of the domain.
permissionsId
String
The unique identifier of the assigned permission.