Domains API reference guide
POST /collectionGET /collectionGET /collection/{collectionId}GET /collection/{collectionId}/allPermissionsGET /collection/{collectionType}/{collectionName}PUT /collection/{collectionId}DELETE /collection/{collectionId}POST /collection/{collectionId}/datasourcesGET /collection/{collectionId}/datasourcesDELETE /collection/{collectionId}/datasources/{dataSourceId}POST /collection/{collectionId}/permissionsPOST /collection/{collectionId}/permissions/bulk-deleteGET /collection/{collectionId}/permissions/{memberType}DELETE /collection/{collectionId}/permissions/{permissionId}GET /collection/permissions/{memberType}/{memberId}DELETE /collection/{collectionId}/permissions/{memberType}/{memberId}/{permissionType}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"
}'{
"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"
}
}curl -X 'GET' \
'https://your.immuta.url.com/collection?type=domain&offset=0&size=10' \
-H 'accept: application/json' \
-H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'{
"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
}curl -X 'GET' \
'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428' \
-H 'accept: application/json' \
-H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'{
"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"
}
}curl -X 'GET' \
'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/allPermissions' \
-H 'accept: application/json' \
-H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'{
"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
}curl -X 'GET' \
'https://your.immuta.url.com/collection/domain/Research' \
-H 'accept: application/json' \
-H 'Authorization: Bearer 9b06b571ab2c45f7ba315a3d80b6b6ec'{
"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"
}
}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."
}'{
"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"
}
}curl -X 'DELETE' \
'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428' \
-H 'accept: application/json' \
-H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'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
}
]'{
"jobId": "e48e15a0-ef5c-11ed-892c-a75afcd86969"
}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'{
"data": [{
"dataSourceId": 36,
"createdAt": "2023-05-10T18:02:57.068Z",
"name": "HR Data",
"type": "queryable",
"platform": "PostgreSQL",
"connectionString": "[email protected]:5432/public",
"schema": "public",
"table": "research_data",
"tags": []
}],
"total": 1
}curl -X 'DELETE' \
'https://your.immuta.url.com/collection/c7458ee9-03e5-4b6f-8395-ad4e49235428/datasources/36' \
-H 'accept: application/json' \
-H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'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"
}
]'{
"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"
}
]
}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"
}
]
}
]'{
"success": [
"d6378973-e15d-4310-8f1e-671c6b08e6a2",
"83e6cb4a-4f41-47b4-b455-16fe518d5068"
],
"errors": []
}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'{
"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
}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'curl -X 'GET' \
'https://your.immuta.url.com/collection/permissions/user/2?offset=0&size=10' \
-H 'accept: application/json' \
-H 'Authorization: Bearer 71bd4a7088554159a7ad1ade9242568f'{
"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"
}
]
}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'