# Manage Domains 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 | 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. | | **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`. | ## Endpoints and methods | Method | Endpoint | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | **POST** | [`/collection`](#post-collection) | Creates a new domain | | **GET** | [`/collection`](#get-collection) | Retrieves all domains | | **GET** | [`/collection/{collectionId}`](#get-collection-collectionid) | Retrieves a specific domain | | **GET** | [`/collection/{collectionId}/allPermissions`](#get-collection-collectionid-allpermissions) | Retrieves all permission IDs for a specific domain | | **GET** | [`/collection/{collectionType}/{collectionName}`](#get-collection-collectiontype-collectionname) | Retrieves a specific domain by name | | **PUT** | [`/collection/{collectionId}`](#put-collection-collectionid) | Updates a domain name or description | | **DELETE** | [`/collection/{collectionId}`](#delete-collection-collectionid) | Deletes a domain | | **POST** | [`/collection/{collectionId}/datasources`](#post-collection-collectionid-datasources) | Adds data sources to a domain | | **GET** | [`/collection/{collectionId}/datasources`](#get-collection-collectionid-datasources) | Retrieves the data sources in the domain | | **DELETE** | [`/collection/{collectionId}/datasources/{dataSourceId}`](#delete-collection-collectionid-datasources-datasourceid) | Deletes a data source from a domain | | **POST** | [`/collection/{collectionId}/permissions`](#post-collection-collectionid-permissions) | Assigns a domain permission to a user | | **POST** | [`/collection/{collectionId}/permissions/bulk-delete`](#post-collection-collectionid-permissions-bulk-delete)\` | Deletes multiple permissions from a collection | | **GET** | [`/collection/{collectionId}/permissions/{memberType}`](#get-collection-collectionid-permissions-membertype) | Retrieves user permissions assigned in the domain | | **DELETE** | [`/collection/{collectionId}/permissions/{permissionId}`](#delete-collection-collectionid-permissions-permissionid) | Removes a domain permission from a user by the permission ID | | **DELETE** | [`/collection/{collectionId}/permissions/{memberType}/{memberId}/{permissionType}`](#delete-collection-collectionid-permissions-membertype-memberid-permissiontype) | Removes a domain permission from a user by the user ID and permission type | | **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 | ## `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](#post-collectioncollectioniddatasources) after creating the domain. ```shell curl -X 'POST' \ 'https://your.immuta.url.com/collection' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer 09a0ffd7512f4aeeb66c09f3111c436c' \ -d '{ "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "name": "Research", "description": "This domain is for research team data.", "type": "domain" }' ``` ### 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 collection. | Required | `domain` | `domain` | ### Response Returns a [domains object](#domain-object-attributes). ```json { "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "type": "domain", "name": "Research", "description": "This domain is for research team data.", "createdAt": "2023-05-10T14:55:29.289Z", "updatedAt": "2023-05-10T14:55:29.289Z", "createdBy": 2, "profile": { "name": "Example User" } } ``` ## `GET` `/collection` Retrieve domains created in Immuta. These results can be filtered by permission or by name. ```shell curl -X 'GET' \ 'https://your.immuta.url.com/collection?type=domain&offset=0&size=10' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec' ``` ### Query parameters The following table describes optional query parameters for retrieving domains. | Parameter | Description | Accepted values | | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | **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. | | | **isExactMatch** `boolean` | If `true`, will only return domains with the exact name. | `true` or `false` | | **isCollectionPolicySearch** `boolean` | If `true`, will only return domains that the user can modify policies on. | `true` or `false` | ### Response Returns a data property that contains an array of up to `size` [domain objects](#domain-object-attributes). If no domains exist, the array will be empty. ```json { "data": [{ "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "type": "domain", "name": "Marketing domain", "description": "This is a collection of marketing data.", "createdAt": "2023-05-10T14:55:29.289Z", "updatedAt": "2023-05-10T14:55:29.289Z", "createdBy": 2, "profile": { "name": "Example User" } }, { "id": "2", "type": "domain", "name": "Test 2", "description": "Another test", "createdAt": "2023-05-10T15:06:15.047Z", "updatedAt": "2023-05-10T15:06:15.047Z", "createdBy": 2, "profile": { "name": "Example User" } }], "total": 2 } ``` ## `GET` `/collection/{collectionId}` Retrieve a domain with the given `collectionId` to view the data sources, description, and assigned permissions associated with the domain. ```shell curl -X 'GET' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec' ``` ### Path parameter | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `string` | The unique identifier of the domain. | ### Response Returns a [domains object](#domain-object-attributes). ```json { "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "type": "domain", "name": "Research", "description": "This domain is for research team data.", "createdAt": "2023-05-10T14:55:29.289Z", "updatedAt": "2023-05-10T14:55:29.289Z", "createdBy": 2, "profile": { "name": "Example User" } } ``` ## `GET` `/collection/{collectionId}/allPermissions` Retrieve all permissions assigned to the specified domain. ```shell curl -X 'GET' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/allPermissions' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec' ``` ### Path parameter | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `string` | The unique identifier of the domain. | ### Query parameters | Parameter | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **type** `string` | The type of permission to return. Acceptable values include `Manage Policies` and `Audit Activity`. | | **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`. | | **size** `integer` | The number of permissions to return. | ### Response Returns an array of [domain permission objects](#domains-permissions-object-attributes) that represent a permission in a domain assigned to a specific user. ```json { "data": [ { "id": "3bafcd54-a18d-406d-a514-cb8a38586b7d", "name": "Taylor", "profileId": 2, "collectionId": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "groupId": null, "permission": "Manage Policies", "createdAt": "2024-05-17T17:25:46.581Z" } ], "total": 1 } ``` ## `GET` `/collection/{collectionType}/{collectionName}` Retrieve a domain with the given `collectionName` to view the data sources, description, and assigned permissions associated with the domain. ```shell curl -X 'GET' \ 'https://your.immuta.url.com/collection/domain/Research' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec' ``` ### Path parameters | Parameter | Description | | --------------------------- | ------------------------------------------------------- | | **collectionType** `string` | The type of collection. The accepted value is `domain`. | | **collectionName** `string` | The name of the domain. | ### Response Returns a [domains object](#domain-object-attributes). ```json { "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "type": "domain", "name": "Research", "description": "This domain is for research team data.", "createdAt": "2023-05-10T14:55:29.289Z", "updatedAt": "2023-05-10T14:55:29.289Z", "createdBy": 2, "profile": { "name": "Example User" } } ``` ## `PUT` `/collection/{collectionId}` Change the domain name or description. You must have the global `GOVERNANCE` permission to update the domain. ```shell curl -X 'PUT' \ 'https://your.immuta.url.com/collection/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." }' ``` ### Parameters **Path parameter** | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `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 Returns a [domains object](#domain-object-attributes) with the new name or description. ```json { "id": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "type": "domain", "name": "HR Research", "description": "This domain is specifically for human resources data and research.", "createdAt": "2023-05-11T14:50:40.855Z", "updatedAt": "2023-05-11T14:53:21.235Z", "createdBy": 2, "profile": { "name": "Example User" } } ``` ## `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. ```shell curl -X 'DELETE' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' ``` ### Parameters **Path parameter** | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `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` `/collection/{collectionId}/datasources` Add 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. ```shell curl -X 'POST' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/datasources' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \ -d '[ { "dataSourceId": 36 } ]' ``` ### Parameters **Path parameter** | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `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. ```json { "jobId": "e48e15a0-ef5c-11ed-892c-a75afcd86969" } ``` ## `GET` `/collection/{collectionId}/datasources` Retrieve the data sources within a domain. ```shell curl -X 'GET' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/datasources?offset=0&size=10' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' ``` ### Parameters **Path parameter** | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `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. ```json { "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` `/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. ```shell curl -X 'DELETE' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/datasources/36' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' ``` ### Path parameters | Parameter | Description | | -------------------------- | ------------------------------------------------------------------------- | | **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. | ### 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` Assign domain permissions to a specific user. You must have the global `USER_ADMIN` permission to assign domain permissions to users. ```shell curl -X 'POST' \ 'https://your.immuta.url.com/collection/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" } ]' ``` ### 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. | | **collectionId** `string` | The unique identifier of the domain. | | **permission** `string` | The permission assigned to the user. Accepted values are `Manage Policies` or `Audit Activity`. | | **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. | ### Parameters **Path parameter** | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `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 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 | - | | ### Response Returns an array of [domain permission objects](#domains-permissions-object-attributes) 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. ```json { "success": [ { "id": "c2ec9049-ac93-4700-9e21-f0ec3a0de6bb", "profileId": 3, "collectionId": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "permission": "Manage Policies", "createdAt": "2023-05-10T18:37:05.847Z" } ], "errors": [ { "profileId": 2, "collectionId": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "permission": "Manage Policies", "message": "Permission already exists" } ] } ``` ## `POST` `/collection/{collectionId}/permissions/bulk-delete` Remove permissions from multiple users or groups in a domain. **Required Immuta permission**: `USER_ADMIN` ```shell curl -X 'POST' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/bulk-delete' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' \ -d '[ { "collectionPermissions": [ { "profileId": 2, "permission": "Manage Policies" }, { "profileId": 3, "permission": "Manage Policies" } ] } ]' ``` ### Parameters #### Path parameter | Parameter | Description | | ------------------------- | ------------------------------------ | | **collectionId** `string` | The unique identifier of the domain. | #### Body parameters | Parameter | Description | Required or Optional | Default values | Accepted values | | --------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------- | -------------- | ---------------------------------------------------------------------------------- | | collectionPermissions.**groupId** `integer` | The unique identifier of the group the permission is assigned to. | Required if **profileId** is not provided | - | - | | collectionPermissions.**profileId** `integer` | The unique identifier of the user the permission is assigned to. | Required if **groupId** is not provided | - | - | | collectionPermissions.**permission** `string` | The domain permission assigned to the user or group. | Required | - | | ### Response Returns an array of [domain permission objects](#domains-permissions-object-attributes) that represent a permission in a domain deleted from that specific user or group. Response includes permissions that failed to delete. ```json { "success": [ "d6378973-e15d-4310-8f1e-671c6b08e6a2", "83e6cb4a-4f41-47b4-b455-16fe518d5068" ], "errors": [] } ``` ## `GET` `/collection/{collectionId}/permissions/{memberType}` Retrieve a list of permissions associated with the domain. ```shell curl -X 'GET' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/user?offset=0&size=10' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' ``` ### Parameters **Path parameters** | Parameter | Description | | ------------------------- | ----------------------------------------------------------------------------------------------- | | **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`. | **Query parameters** | Parameter | Description | Accepted values | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | **type** `string` | The permission to return. | | | **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. | | | **sortOrder** `string` | Specifies how to sort the results of the request. | | ### Response Returns a data property that contains an array of users or groups who have been assigned that permission in the domain. ```json { "data": [{ "id": "1bf5fa36-8130-4f72-8f4f-d1f18c25c2a2", "name": "Example User", "profileId": 2, "collectionId": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "permission": "Manage Policies", "source": [ "User Permission(s)" ] }, { "id": "6172d495-c560-4ae1-bceb-cc6ce15e55ec", "name": "Example User 2", "profileId": 3, "collectionId": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "permission": "Manage Policies", "source": [ "User Permission(s)" ] }], "total": 2 } ``` ## `GET` `/collection/permissions/{memberType}/{memberId}` Retrieve a list of permissions for the specified user or group across all domains they are a member of. ```shell curl -X 'GET' \ 'https://your.immuta.url.com/collection/permissions/user/2?offset=0&size=10' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' ``` ### Parameters #### 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. | | | **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. | | | **sortOrder** `string` | Specifies how to sort the results of the request. | | ### 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. ```json { "data": [{ "profileId": 2, "name": "Taylor", "collectionId": "c7458ee9-03e5-4b6f-8395-ad4e49235428", "collectionName": "Marketing domain", "permission": "Manage Policies", "source": [ "User Permission(s)" ], "userObjectId": 2, "iamId": "bim" }, { "profileId": 2, "name": "Taylor", "collectionId": "a5678ef9-53e5-4b6f-8395-aa4e49237689", "collectionName": "Customer support domain", "permission": "Manage Policies", "source": [ "User Permission(s)" ], "userObjectId": 2, "iamId": "bim" } ] } ``` ## `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. ```shell curl -X 'DELETE' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/c2ec9049-ac93-4700-9e21-f0ec3a0de6bb' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' ``` ### Path parameters
ParameterDescription
collectionId stringThe unique identifier of the domain.
permissionId stringThe 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**: 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. ```shell curl -X 'DELETE' \ 'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/permissions/user/2/Manage%20Policies' \ -H 'accept: application/json' \ -H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f' ``` ### Path parameters | Parameter | Description | | --------------------------- | -------------------------------------------------------------------------------------------- | | **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 values are `Manage Policies` or `Audit Activity`. | ### 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