bigid

BigID - data discovery, catalog, security posture, privacy (DSAR), and data source management

Server path: /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	—	Additional Properties
subType	string	Yes	—	Must be “updateCases”
type	string	Yes	—	Must be “CasesDB”

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "additionalProperties": {
      "type": "object",
      "description": "Additional Properties",
      "properties": {
        "field": {
          "type": "string",
          "description": "Field to update (e.g., caseStatus)"
        },
        "newValue": {
          "type": "string",
          "description": "New value for the field"
        },
        "casesFilters": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Cases Filters"
        }
      }
    },
    "subType": {
      "type": "string",
      "description": "Must be \"updateCases\""
    },
    "type": {
      "type": "string",
      "description": "Must be \"CasesDB\""
    }
  },
  "required": [
    "PCID",
    "additionalProperties",
    "subType",
    "type"
  ]
}

---

bigid_create_data_source

Create a new data source connection

Parameters:

Parameter	Type	Required	Default	Description
ds_connection	object	Yes	—	Data source connection configuration

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ds_connection": {
      "type": "object",
      "description": "Data source connection configuration",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name for the data source"
        },
        "type": {
          "type": "string",
          "description": "Data source connector type (e.g., rdb-mysql, s3)"
        }
      }
    }
  },
  "required": [
    "PCID",
    "ds_connection"
  ]
}

---

bigid_create_scan_profile

Create a new scan profile

Parameters:

Parameter	Type	Required	Default	Description
dataSourceList	string[]	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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dataSourceList": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of data source IDs to include in the scan"
    },
    "description": {
      "type": "string",
      "description": "Description of the scan profile"
    },
    "isSingleRunScan": {
      "type": "boolean",
      "description": "Whether this is a one-time scan"
    },
    "name": {
      "type": "string",
      "description": "Name for the scan profile"
    },
    "scanTemplateId": {
      "type": "string",
      "description": "ID of the scan template to use"
    }
  },
  "required": [
    "PCID",
    "dataSourceList",
    "name"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "string",
      "description": "Comma-separated list of data source IDs to export (omit for all)"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "object_name": {
      "type": "string",
      "description": "Full path to the unstructured file or object"
    }
  },
  "required": [
    "PCID",
    "object_name"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "object_name": {
      "type": "string",
      "description": "Full object path (format: DataSourceName.schemaName.tableName)"
    }
  },
  "required": [
    "PCID",
    "object_name"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "clusterId": {
      "type": "string",
      "description": "Cluster ID to retrieve columns for"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum results to return"
    },
    "skip": {
      "type": "integer",
      "description": "Number of results to skip for pagination"
    },
    "filter": {
      "type": "string",
      "description": "Filter by column metadata"
    },
    "searchText": {
      "type": "string",
      "description": "Search column names or attributes"
    },
    "sort": {
      "type": "string",
      "description": "Sort field"
    }
  },
  "required": [
    "PCID",
    "clusterId"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "connectorType": {
      "type": "string",
      "description": "Connector type identifier (e.g., rdb-mysql, s3, kinesis)"
    }
  },
  "required": [
    "PCID",
    "connectorType"
  ]
}

---

bigid_get_dsar_attributes

Get available attributes for a DSAR profile

Parameters:

Parameter	Type	Required	Default	Description
profileId	string	Yes	—	DSAR profile ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "profileId": {
      "type": "string",
      "description": "DSAR profile ID"
    }
  },
  "required": [
    "PCID",
    "profileId"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "requestId": {
      "type": "string",
      "description": "DSAR request ID"
    },
    "format": {
      "type": "string",
      "description": "Report output format (json or csv)",
      "enum": [
        "json",
        "csv"
      ]
    }
  },
  "required": [
    "PCID",
    "requestId"
  ]
}

---

bigid_get_dsar_status

Check the status of a DSAR request

Parameters:

Parameter	Type	Required	Default	Description
requestId	string	Yes	—	DSAR request ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "requestId": {
      "type": "string",
      "description": "DSAR request ID"
    }
  },
  "required": [
    "PCID",
    "requestId"
  ]
}

---

bigid_get_scan_profile

Retrieve details of a specific scan profile

Parameters:

Parameter	Type	Required	Default	Description
profileId	string	Yes	—	Unique scan profile identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "profileId": {
      "type": "string",
      "description": "Unique scan profile identifier"
    }
  },
  "required": [
    "PCID",
    "profileId"
  ]
}

---

bigid_get_scan_status

Check the current status of a specific scan

Parameters:

Parameter	Type	Required	Default	Description
scanId	string	Yes	—	Scan execution ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "scanId": {
      "type": "string",
      "description": "Scan execution ID"
    }
  },
  "required": [
    "PCID",
    "scanId"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "profileId": {
      "type": "string",
      "description": "DSAR profile ID to use"
    },
    "userDetails": {
      "type": "object",
      "description": "Details of the data subject",
      "properties": {
        "attributes": {
          "type": "object",
          "description": "Key-value pairs of subject attributes"
        },
        "userId": {
          "type": "string",
          "description": "Unique identifier for the data subject"
        },
        "displayName": {
          "type": "string",
          "description": "Display name of the data subject"
        }
      }
    }
  },
  "required": [
    "PCID",
    "profileId",
    "userDetails"
  ]
}

---

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}“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "string",
      "description": "Filter expression (e.g., has_duplicates=\"true\" or duplicate_id=\"{id}\")"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "string",
      "description": "Filter expression (e.g., filter by cluster size)"
    }
  },
  "required": [
    "PCID"
  ]
}

---

bigid_list_data_source_templates

List available data source connector types

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

bigid_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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "skip": {
      "type": "integer",
      "description": "Number of records to skip for pagination"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of data sources to return"
    },
    "requireTotalCount": {
      "type": "boolean",
      "description": "Whether to include total count in response"
    },
    "sort": {
      "type": "string",
      "description": "Sort results by specified field"
    },
    "filter": {
      "type": "string",
      "description": "Filter results based on field values"
    }
  },
  "required": [
    "PCID"
  ]
}

---

bigid_list_dsar_profiles

List available DSAR profiles

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

bigid_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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of scans to return"
    },
    "sort": {
      "type": "string",
      "description": "Sort field (default descending by updated_at)"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "skip": {
      "type": "integer",
      "description": "Number of records to skip for pagination"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of records to return"
    },
    "filter": {
      "type": "string",
      "description": "BigID Query Language filter to narrow results"
    },
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to return"
    },
    "sort": {
      "type": "string",
      "description": "Sort field with optional ASC/DESC"
    },
    "requireTotalCount": {
      "type": "boolean",
      "description": "Whether to include totalCount in response"
    }
  },
  "required": [
    "PCID"
  ]
}

---

bigid_list_system_users

List system users (also used as connection test endpoint)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ds_connection": {
      "type": "object",
      "description": "Data source connection credentials to test"
    },
    "isNewPassword": {
      "type": "boolean",
      "description": "Whether the password is new"
    }
  },
  "required": [
    "PCID",
    "ds_connection"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "caseId": {
      "type": "string",
      "description": "The case ID to update"
    },
    "auditReason": {
      "type": "string",
      "description": "Reason for the status change (for audit trail)"
    },
    "caseStatus": {
      "type": "string",
      "description": "New status value (e.g., resolved, open, dismissed)"
    }
  },
  "required": [
    "PCID",
    "caseId",
    "caseStatus"
  ]
}