Generate Governance Reports
Governance API reference guide
This page describes the /governance
endpoint of the Immuta API and its request parameters used to generate governance reports.
Additional fields may be included in some responses you receive; however, these attributes
are for internal purposes and are therefore undocumented.
Endpoints
Method | Endpoint | Description |
---|---|---|
GET | Generate a report of all the data sources that all users are currently subscribed to. | |
GET | Generate a report of all current users and details about them. | |
GET | Generate a report of the data sources the specified user is currently subscribed to. | |
GET | Generate a report of the groups the specified user is currently a member of. | |
GET | Generate a report of the projects the specified user is currently a member of. | |
GET | Generate a report of all the purposes the user has accessed data for during the specified date range. | |
GET | Generate a report of all the data sources the user has directly accessed during the specified date range. | |
GET | Generate a report of all the attributes the specified user currently has. | |
GET | Generate a report of all the data sources that any member in any group is subscribed to. | |
GET | Generate a report of all the users who are currently a member of the group. | |
GET | Generate a report of all the data sources that members of the group are currently subscribed to. | |
GET | Generate a report of all the projects that the members of the group are currently subscribed to. | |
GET | Generate a report of all the attributes currently assigned to the specified group. | |
GET | Generate a report of all the data sources and members currently in the project. | |
GET | Generate a report of all the data sources currently in the specified project. | |
GET | Generate a report of all the purposes currently assigned to the specified project. | |
GET | Generate a report of every user and group currently subscribed to any data source. | |
GET | Generate a report of the all the users and groups currently subscribed to the specified data source. | |
GET | Generate a report of the projects that currently have the specified data source. | |
GET | Generate a report of the purpose of every project that has the specified data source. | |
GET | Generate a report of the users that have accessed the data source during the specified date range. | |
GET | Generate a report of the purposes the data source has been accessed for during the specified date range. | |
GET | Generate a report of the users and groups that have been subscribed to the data source during the specified data range. | |
GET | Generate a report of data discovery scoring information for every column in the specified data source. | |
GET | Generate a report of all current members of the projects that use the purpose. | |
GET | Generate a report of all current data sources of the projects that use the specified purpose. | |
GET | Generate a report of all other purposes currently combined with the specified purpose. | |
GET | Generate a report of projects with the specified purpose currently assigned. | |
GET | Generate a report of data sources that have been accessed for the purpose during the specified date range. | |
GET | Generate a report of the users who have subscribed to data sources that were tagged with any tag since the specified start date. | |
GET | Generate a report of the projects with data sources currently tagged with any tag. | |
GET | Generate a report of every data source currently tagged with any tag. | |
GET | Generate a report of the data sources currently tagged with the specified tag. | |
GET | Generate a report of users who have accessed data sources tagged with the specified tag during the specified date range. | |
GET | Generate a report of the purposes that have been used to access data with the specified tag during the specified date range. | |
GET | Generate a report of the projects that have data sources currently tagged with this tag. | |
GET | Generate a report of the data sources this data policy type is currently applied to. | |
GET | Generate a report of all disabled global policies. | |
GET | Generate a report of all policies currently in conflict. | |
GET | Generate a report of all data sources the specified policy has not been certified on. | |
GET | Generate a report of all data sources the specified policy has been certified on. | |
GET | Generate a report of all data sources the specified global policy is applied to. | |
GET | Generate a report of all columns with Discovered tags currently applied. | |
GET | Generate a report of all columns with legacy Discovered tags currently applied. |
GET
/governance/reports/user/allUserDataSources
GET
/governance/reports/user/allUserDataSources
Generate a report of all the data sources that all users are currently subscribed to.
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/user/allUserStatus
GET
/governance/reports/user/allUserStatus
Generate a report of all current users and details about them.
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/user/{userId}/dataSource
GET
/governance/reports/user/{userId}/dataSource
Generate a report of the data sources the specified user is currently subscribed to.
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/user/{userId}/group
GET
/governance/reports/user/{userId}/group
Generate a report of the groups the specified user is currently a member of.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
userId | The unique identifier of the user. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/user/{userId}/project
GET
/governance/reports/user/{userId}/project
Generate a report of the projects the specified user is currently a member of.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
userId | The unique identifier of the user. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/user/{userId}/dataSourcePurposeAccess
GET
/governance/reports/user/{userId}/dataSourcePurposeAccess
Generate a report of all the purposes the user has accessed data for during the specified date range.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
userId | The unique identifier of the user. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
startDate | The beginning date of the date range. Must be within 90 days of the current date. Ex: | Required |
endDate | The ending date of the date range. Must be within 90 days of the current date. Ex: | Required |
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/user/{userId}/dataSourceUserAccess
GET
/governance/reports/user/{userId}/dataSourceUserAccess
Generate a report of all the data sources the user has directly accessed during the specified date range.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
userId | The unique identifier of the user. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
startDate | The beginning date of the date range. Must be within 90 days of the current date. Ex: | Required |
endDate | The ending date of the date range. Must be within 90 days of the current date. Ex: | Required |
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/user/{userId}/attribute
GET
/governance/reports/user/{userId}/attribute
Generate a report of all the attributes the specified user currently has.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
userId | The unique identifier of the user. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/group/allGroupDataSourceAccess
GET
/governance/reports/group/allGroupDataSourceAccess
Generate a report of all the data sources that any member in any group is subscribed to.
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/group/{groupId}/user
GET
/governance/reports/group/{groupId}/user
Generate a report of all the users who are currently a member of the group.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
groupId | The unique identifier of the group. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/group/{groupId}/dataSource
GET
/governance/reports/group/{groupId}/dataSource
Generate a report of all the data sources that members of the group are currently subscribed to.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
groupId | The unique identifier of the group. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/group/{groupId}/project
GET
/governance/reports/group/{groupId}/project
Generate a report of all the projects that the members of the group are currently subscribed to.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
groupId | The unique identifier of the group. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/group/{groupId}/attribute
GET
/governance/reports/group/{groupId}/attribute
Generate a report of all the attributes currently assigned to the specified group.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
groupId | The unique identifier of the group. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/project/{projectId}/user
GET
/governance/reports/project/{projectId}/user
Generate a report of all the data sources and members currently in the project.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
projectId | The unique identifier of the project. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/project/{projectId}/dataSource
GET
/governance/reports/project/{projectId}/dataSource
Generate a report of all the data sources currently in the specified project.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
projectId | The unique identifier of the project. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/project/{projectId}/purpose
GET
/governance/reports/project/{projectId}/purpose
Generate a report of all the purposes currently assigned to the specified project.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
projectId | The unique identifier of the project. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/allDataSourceUsers
GET
/governance/reports/dataSource/allDataSourceUsers
Generate a report of every user and group currently subscribed to any data source.
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/{dataSourceId}/user
GET
/governance/reports/dataSource/{dataSourceId}/user
Generate a report of the all the users and groups currently subscribed to the specified data source.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
dataSourceId | The unique identifier of the data source. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/{dataSourceId}/project
GET
/governance/reports/dataSource/{dataSourceId}/project
Generate a report of the projects that currently have the specified data source.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
dataSourceId | The unique identifier of the data source. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/{dataSourceId}/purpose
GET
/governance/reports/dataSource/{dataSourceId}/purpose
Generate a report of the purpose of every project that has the specified data source.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
dataSourceId | The unique identifier of the data source. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/{dataSourceId}/dataSourceUserAccess
GET
/governance/reports/dataSource/{dataSourceId}/dataSourceUserAccess
Generate a report of the users that have accessed the data source during the specified date range.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
dataSourceId | The unique identifier of the data source. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
startDate | The beginning date of the date range. Must be within 90 days of the current date. Ex: | Required |
endDate | The ending date of the date range. Must be within 90 days of the current date. Ex: | Required |
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/{dataSourceId}/dataSourcePurposeAccess
GET
/governance/reports/dataSource/{dataSourceId}/dataSourcePurposeAccess
Generate a report of the purposes the data source has been accessed for during the specified date range.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
dataSourceId | The unique identifier of the data source. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
startDate | The beginning date of the date range. Must be within 90 days of the current date. Ex: | Required |
endDate | The ending date of the date range. Must be within 90 days of the current date. Ex: | Required |
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/{dataSourceId}/subscriptionHistory
GET
/governance/reports/dataSource/{dataSourceId}/subscriptionHistory
Generate a report of the users and groups that have been subscribed to the data source during the specified data range.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
dataSourceId | The unique identifier of the data source. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
startDate | The beginning date of the date range. Must be within 90 days of the current date. Ex: | Required |
endDate | The ending date of the date range. Must be within 90 days of the current date. Ex: | Required |
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/dataSource/{dataSourceId}/dataSourceSddScoring
GET
/governance/reports/dataSource/{dataSourceId}/dataSourceSddScoring
Generate a report of data discovery scoring information for every column in the specified data source.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
dataSourceId | The unique identifier of the data source. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/purpose/{purposeId}/user
GET
/governance/reports/purpose/{purposeId}/user
Generate a report of all current members of the projects that use the specified purpose.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
purposeId | The unique identifier of the purpose. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/purpose/{purposeId}/dataSource
GET
/governance/reports/purpose/{purposeId}/dataSource
Generate a report of all current data sources of the projects that use the specified purpose.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
purposeId | The unique identifier of the purpose. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/purpose/{purposeId}/purpose
GET
/governance/reports/purpose/{purposeId}/purpose
Generate a report of all other purposes currently combined with the specified purpose.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
purposeId | The unique identifier of the purpose. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/purpose/{purposeId}/project
GET
/governance/reports/purpose/{purposeId}/project
Generate a report of projects with the specified purpose currently assigned.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
purposeId | The unique identifier of the purpose. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/purpose/{purposeId}/dataSourcePurposeAccess
GET
/governance/reports/purpose/{purposeId}/dataSourcePurposeAccess
Generate a report of data sources that have been accessed for the specified purpose during the specified date range.
Request parameter
Parameter | Description | Required or optional |
---|---|---|
purposeId | The unique identifier of the purpose. | Required |
Query parameters
Parameter | Description | Required or optional |
---|---|---|
startDate | The beginning date of the date range. Must be within 90 days of the current date. Ex: | Required |
endDate | The ending date of the date range. Must be within 90 days of the current date. Ex: | Required |
size | The number of results to return per page. | Optional |
offset | The number of items from the beginning of the response to exclude. You can combine the | Optional |
sortField | Used to sort results by field. | Optional |
sortOrder | Sorts results by order, which must be | Optional |
export | If | Optional |
GET
/governance/reports/tag/allDataSourceUserAccess
GET
/governance/reports/tag/allDataSourceUserAccess
Generate a report of the users who have subscribed to data sources that were tagged with any tag since the specified start date.
Query parameters
Parameter | Description | Required or optional |
---|---|---|
startDate | The date to start the report at. Must be within 90 days of the current date. Ex: | Required |
size | The number of results to return per page. | Optional |