/bigid | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
bigid_bulk_update_security_cases | Bulk update security case statuses |
bigid_create_data_source | Create a new data source connection |
bigid_create_scan_profile | Create a new scan profile |
bigid_export_data_sources | Export configured data sources as a JSON file |
bigid_get_catalog_object_attributes | Retrieve attributes for an unstructured data object |
bigid_get_catalog_object_columns | Retrieve column metadata for a structured table |
bigid_get_cluster_columns | Get columns belonging to a specific cluster |
bigid_get_data_source_template | Get the configuration template for a specific connector type |
bigid_get_dsar_attributes | Get available attributes for a DSAR profile |
bigid_get_dsar_report | Retrieve the short report for a completed DSAR request |
bigid_get_dsar_status | Check the status of a DSAR request |
bigid_get_scan_profile | Retrieve details of a specific scan profile |
bigid_get_scan_status | Check the current status of a specific scan |
bigid_initiate_dsar | Initiate a Data Subject Access Request |
bigid_list_catalog_objects | List data catalog objects with optional filtering |
bigid_list_clusters | List data clusters with optional filtering |
bigid_list_data_source_templates | List available data source connector types |
bigid_list_data_sources | Retrieve a list of data source connections |
bigid_list_dsar_profiles | List available DSAR profiles |
bigid_list_scans | Get a high-level overview of scan executions |
bigid_list_security_cases | Retrieve security issues and actionable insights |
bigid_list_system_users | List system users (also used as connection test endpoint) |
bigid_test_data_source_connection | Test a data source connection to verify credentials and network access |
bigid_update_security_case_status | Update the status of a single security case |
bigid_bulk_update_security_cases
Bulk update security case statuses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
additionalProperties | object | Yes | — | additionalProperties |
subType | string | Yes | — | Must be “updateCases” |
type | string | Yes | — | Must be “CasesDB” |
bigid_create_data_source
Create a new data source connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ds_connection | object | Yes | — | Data source connection configuration |
bigid_create_scan_profile
Create a new scan profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataSourceList | any[] | Yes | — | List of data source IDs to include in the scan |
description | string | No | — | Description of the scan profile |
isSingleRunScan | boolean | No | — | Whether this is a one-time scan |
name | string | Yes | — | Name for the scan profile |
scanTemplateId | string | No | — | ID of the scan template to use |
bigid_export_data_sources
Export configured data sources as a JSON file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string | No | — | Comma-separated list of data source IDs to export (omit for all) |
bigid_get_catalog_object_attributes
Retrieve attributes for an unstructured data object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
object_name | string | Yes | — | Full path to the unstructured file or object |
bigid_get_catalog_object_columns
Retrieve column metadata for a structured table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
object_name | string | Yes | — | Full object path (format: DataSourceName.schemaName.tableName) |
bigid_get_cluster_columns
Get columns belonging to a specific cluster Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clusterId | string | Yes | — | Cluster ID to retrieve columns for |
limit | integer | No | — | Maximum results to return |
skip | integer | No | — | Number of results to skip for pagination |
filter | string | No | — | Filter by column metadata |
searchText | string | No | — | Search column names or attributes |
sort | string | No | — | Sort field |
bigid_get_data_source_template
Get the configuration template for a specific connector type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connectorType | string | Yes | — | Connector type identifier (e.g., rdb-mysql, s3, kinesis) |
bigid_get_dsar_attributes
Get available attributes for a DSAR profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | DSAR profile ID |
bigid_get_dsar_report
Retrieve the short report for a completed DSAR request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
requestId | string | Yes | — | DSAR request ID |
format | string | No | — | Report output format (json or csv) |
bigid_get_dsar_status
Check the status of a DSAR request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
requestId | string | Yes | — | DSAR request ID |
bigid_get_scan_profile
Retrieve details of a specific scan profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Unique scan profile identifier |
bigid_get_scan_status
Check the current status of a specific scan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scanId | string | Yes | — | Scan execution ID |
bigid_initiate_dsar
Initiate a Data Subject Access Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | DSAR profile ID to use |
userDetails | object | Yes | — | Details of the data subject |
bigid_list_catalog_objects
List data catalog objects with optional filtering Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Filter expression (e.g., has_duplicates=“true” or duplicate_id=“{id}“) |
bigid_list_clusters
List data clusters with optional filtering Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Filter expression (e.g., filter by cluster size) |
bigid_list_data_source_templates
List available data source connector typesbigid_list_data_sources
Retrieve a list of data source connections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skip | integer | No | — | Number of records to skip for pagination |
limit | integer | No | — | Maximum number of data sources to return |
requireTotalCount | boolean | No | — | Whether to include total count in response |
sort | string | No | — | Sort results by specified field |
filter | string | No | — | Filter results based on field values |
bigid_list_dsar_profiles
List available DSAR profilesbigid_list_scans
Get a high-level overview of scan executions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of scans to return |
sort | string | No | — | Sort field (default descending by updated_at) |
bigid_list_security_cases
Retrieve security issues and actionable insights Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skip | integer | No | — | Number of records to skip for pagination |
limit | integer | No | — | Maximum number of records to return |
filter | string | No | — | BigID Query Language filter to narrow results |
fields | string | No | — | Comma-separated list of fields to return |
sort | string | No | — | Sort field with optional ASC/DESC |
requireTotalCount | boolean | No | — | Whether to include totalCount in response |
bigid_list_system_users
List system users (also used as connection test endpoint)bigid_test_data_source_connection
Test a data source connection to verify credentials and network access Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ds_connection | object | Yes | — | Data source connection credentials to test |
isNewPassword | boolean | No | — | Whether the password is new |
bigid_update_security_case_status
Update the status of a single security case Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | The case ID to update |
auditReason | string | No | — | Reason for the status change (for audit trail) |
caseStatus | string | Yes | — | New status value (e.g., resolved, open, dismissed) |

