Skip to main content
Server path: /bigid | Type: Application | PCID required: Yes

Tools

ToolDescription
bigid_bulk_update_security_casesBulk update security case statuses
bigid_create_data_sourceCreate a new data source connection
bigid_create_scan_profileCreate a new scan profile
bigid_export_data_sourcesExport configured data sources as a JSON file
bigid_get_catalog_object_attributesRetrieve attributes for an unstructured data object
bigid_get_catalog_object_columnsRetrieve column metadata for a structured table
bigid_get_cluster_columnsGet columns belonging to a specific cluster
bigid_get_data_source_templateGet the configuration template for a specific connector type
bigid_get_dsar_attributesGet available attributes for a DSAR profile
bigid_get_dsar_reportRetrieve the short report for a completed DSAR request
bigid_get_dsar_statusCheck the status of a DSAR request
bigid_get_scan_profileRetrieve details of a specific scan profile
bigid_get_scan_statusCheck the current status of a specific scan
bigid_initiate_dsarInitiate a Data Subject Access Request
bigid_list_catalog_objectsList data catalog objects with optional filtering
bigid_list_clustersList data clusters with optional filtering
bigid_list_data_source_templatesList available data source connector types
bigid_list_data_sourcesRetrieve a list of data source connections
bigid_list_dsar_profilesList available DSAR profiles
bigid_list_scansGet a high-level overview of scan executions
bigid_list_security_casesRetrieve security issues and actionable insights
bigid_list_system_usersList system users (also used as connection test endpoint)
bigid_test_data_source_connectionTest a data source connection to verify credentials and network access
bigid_update_security_case_statusUpdate the status of a single security case

bigid_bulk_update_security_cases

Bulk update security case statuses Parameters:
ParameterTypeRequiredDefaultDescription
additionalPropertiesobjectYesadditionalProperties
subTypestringYesMust be “updateCases”
typestringYesMust be “CasesDB”

bigid_create_data_source

Create a new data source connection Parameters:
ParameterTypeRequiredDefaultDescription
ds_connectionobjectYesData source connection configuration

bigid_create_scan_profile

Create a new scan profile Parameters:
ParameterTypeRequiredDefaultDescription
dataSourceListany[]YesList of data source IDs to include in the scan
descriptionstringNoDescription of the scan profile
isSingleRunScanbooleanNoWhether this is a one-time scan
namestringYesName for the scan profile
scanTemplateIdstringNoID of the scan template to use

bigid_export_data_sources

Export configured data sources as a JSON file Parameters:
ParameterTypeRequiredDefaultDescription
idsstringNoComma-separated list of data source IDs to export (omit for all)

bigid_get_catalog_object_attributes

Retrieve attributes for an unstructured data object Parameters:
ParameterTypeRequiredDefaultDescription
object_namestringYesFull path to the unstructured file or object

bigid_get_catalog_object_columns

Retrieve column metadata for a structured table Parameters:
ParameterTypeRequiredDefaultDescription
object_namestringYesFull object path (format: DataSourceName.schemaName.tableName)

bigid_get_cluster_columns

Get columns belonging to a specific cluster Parameters:
ParameterTypeRequiredDefaultDescription
clusterIdstringYesCluster ID to retrieve columns for
limitintegerNoMaximum results to return
skipintegerNoNumber of results to skip for pagination
filterstringNoFilter by column metadata
searchTextstringNoSearch column names or attributes
sortstringNoSort field

bigid_get_data_source_template

Get the configuration template for a specific connector type Parameters:
ParameterTypeRequiredDefaultDescription
connectorTypestringYesConnector type identifier (e.g., rdb-mysql, s3, kinesis)

bigid_get_dsar_attributes

Get available attributes for a DSAR profile Parameters:
ParameterTypeRequiredDefaultDescription
profileIdstringYesDSAR profile ID

bigid_get_dsar_report

Retrieve the short report for a completed DSAR request Parameters:
ParameterTypeRequiredDefaultDescription
requestIdstringYesDSAR request ID
formatstringNoReport output format (json or csv)

bigid_get_dsar_status

Check the status of a DSAR request Parameters:
ParameterTypeRequiredDefaultDescription
requestIdstringYesDSAR request ID

bigid_get_scan_profile

Retrieve details of a specific scan profile Parameters:
ParameterTypeRequiredDefaultDescription
profileIdstringYesUnique scan profile identifier

bigid_get_scan_status

Check the current status of a specific scan Parameters:
ParameterTypeRequiredDefaultDescription
scanIdstringYesScan execution ID

bigid_initiate_dsar

Initiate a Data Subject Access Request Parameters:
ParameterTypeRequiredDefaultDescription
profileIdstringYesDSAR profile ID to use
userDetailsobjectYesDetails of the data subject

bigid_list_catalog_objects

List data catalog objects with optional filtering Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoFilter expression (e.g., has_duplicates=“true” or duplicate_id=“{id}“)

bigid_list_clusters

List data clusters with optional filtering Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoFilter expression (e.g., filter by cluster size)

bigid_list_data_source_templates

List available data source connector types

bigid_list_data_sources

Retrieve a list of data source connections Parameters:
ParameterTypeRequiredDefaultDescription
skipintegerNoNumber of records to skip for pagination
limitintegerNoMaximum number of data sources to return
requireTotalCountbooleanNoWhether to include total count in response
sortstringNoSort results by specified field
filterstringNoFilter results based on field values

bigid_list_dsar_profiles

List available DSAR profiles

bigid_list_scans

Get a high-level overview of scan executions Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of scans to return
sortstringNoSort field (default descending by updated_at)

bigid_list_security_cases

Retrieve security issues and actionable insights Parameters:
ParameterTypeRequiredDefaultDescription
skipintegerNoNumber of records to skip for pagination
limitintegerNoMaximum number of records to return
filterstringNoBigID Query Language filter to narrow results
fieldsstringNoComma-separated list of fields to return
sortstringNoSort field with optional ASC/DESC
requireTotalCountbooleanNoWhether 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:
ParameterTypeRequiredDefaultDescription
ds_connectionobjectYesData source connection credentials to test
isNewPasswordbooleanNoWhether the password is new

bigid_update_security_case_status

Update the status of a single security case Parameters:
ParameterTypeRequiredDefaultDescription
caseIdstringYesThe case ID to update
auditReasonstringNoReason for the status change (for audit trail)
caseStatusstringYesNew status value (e.g., resolved, open, dismissed)