BigID Hosted MCP Server
Overview
Section titled “Overview”The BigID cloud MCP server enables you to connect AI tools (such as Claude Desktop, Claude Code, Cursor, VS Code, and ChatGPT) to the BigID APIs and skills using natural language prompts.
The BigID Connector provides seamless access to your BigID environment. Connect to data sources, customize and run scan workflows, and explore your unified data catalog. Gain full visibility into your data security posture with capabilities across DSPM, access governance, privacy, and labeling. Manage regulatory risk, automate assessments, and detect violations in real time. Take immediate remediation actions — reduce access, delete or clean sensitive data, and enforce controls, ensuring end-to-end data and AI protection in one unified connector.
Prerequisites
Section titled “Prerequisites”- Claude Code installed and signed in
- Access to your BigID environment
-
Add the MCP server by running the following command in your terminal:
Terminal window claude mcp add --transport http --scope user bigid-staging-mcp https://bigid-mcp.ci.bigid-integrations.netThis adds the following entry to
~/.claude.jsonunder themcpServerskey:{"bigid-staging-mcp": {"type": "http","url": "https://bigid-mcp.ci.bigid-integrations.net"}} -
Open the MCP server list by running
/mcpinside Claude Code.You’ll see the Manage MCP servers dialog listing all configured servers, for example:
Manage MCP servers19 serversLocal MCPs (~/.claude.json [project: .../mcp])❯ bigid-staging-mcp · △ needs authentication -
Select
bigid-staging-mcpto open the server detail view:Status: △ needs authenticationURL: https://bigid-mcp.ci.bigid-integrations.netConfig location: Local MCPs❯ 1. Authenticate2. Disable -
Choose Authenticate. Claude Code opens a browser tab and navigates to the MCP login page.
-
Enter your BigID environment URL — for example,
https://<tenant>.bigid.cloudfor production environments. -
Sign in with your BigID IdP. You’ll be redirected to your Identity Provider (Auth0, Okta, or SAML) to authenticate with your normal BigID credentials.
-
Confirm the connection. After a successful login you’ll see:
Authentication successful. Connected to bigid-staging-mcp.The server status in
/mcpchanges from△ needs authenticationto✓ connected, and the BigID tools become available to Claude Code.
Troubleshooting
Section titled “Troubleshooting”| Problem | Fix |
|---|---|
| Browser tab doesn’t open | Re-run /mcp and select Authenticate again |
| Stuck on BigID URL page | Verify the URL matches your environment exactly (include https:// and port if required) |
| IdP login fails | Confirm you can log into the BigID UI directly with the same credentials |
| Status stays “needs authentication” after login | Re-open /mcp, disable and re-enable the server, then authenticate again |
Available Apps & APIs
Section titled “Available Apps & APIs”The BigID MCP server exposes APIs across the following application areas. Click each app to see its available endpoints.
Remediation
| Route | Summary | Type |
|---|---|---|
GET /settings/policies | List policies configured for remediation | READ |
POST /settings/policies | Configure one or more policies for remediation | WRITE |
GET /settings/configurations | List remediation configuration settings | READ |
GET /settings/actions | List available remediation actions | READ |
GET /settings/actions/rules | List automated action rules (presets) | READ |
GET /objects/{id}/comments | Get comments for a specific object | READ |
GET /datasources | List data sources with filtering and pagination | READ |
GET /datasources/{id} | Get a data source by ID | READ |
GET /datasources/{id}/comments | Get comments for a specific data source | READ |
GET /datasources/summary | Get remediation summary for data sources | READ |
GET /objects | List remediation objects with filtering and pagination | READ |
GET /objects/details | Get detailed information for a specific object | READ |
GET /objects/count | Get total count of remediation objects | READ |
GET /user-preferences/permissions | Get current user permissions | READ |
GET /settings/sync/audit-trail | Retrieve sync execution status | READ |
GET /settings/sync/audit-trail/{id} | Retrieve sync execution status by ID | READ |
ACI (Access Control Intelligence)
| Route | Summary | Type |
|---|---|---|
GET /api/v1/aci/users | List users with access details | READ |
GET /api/v1/aci/users/{id} | Get user by ID | READ |
GET /api/v1/aci/users/insights/byDataSource | Get user insights by data source | READ |
GET /api/v1/aci/users/insights/byVisibility | Get user insights by visibility | READ |
GET /api/v1/aci/users/insights/top-users | Get top users by shared object count | READ |
GET /api/v1/aci/groups | List groups with access details | READ |
GET /api/v1/aci/groups/{id} | Get group by ID | READ |
GET /api/v1/aci/groups/insights/byDataSource | Get group insights by data source | READ |
GET /api/v1/aci/groups/insights/byVisibility | Get group insights by visibility | READ |
GET /api/v1/aci/groups/insights/top-users | Get top groups by shared object count | READ |
GET /api/v1/aci/categories | List categories with open access files | READ |
GET /api/v1/aci/ad/config/{name} | Get AD configuration by name | READ |
GET /api/v1/aci/ad/syncByName/{name} | Get AD sync state by config name | READ |
GET /api/v1/aci/ad/groups/members | Get AD group members | READ |
GET /api/v1/aci/coa | List access types | READ |
GET /api/v1/aci/coa/all-labels | List all access types with scope filtering | READ |
GET /api/v1/aci/coa/{name} | Get access type by name | READ |
GET /api/v1/aci/mappable-labels/providers | Get all external labels providers | READ |
GET /api/v1/aci/mappable-labels/providers/{type}/{providerId} | Get labels provider by type and ID | READ |
GET /api/v1/aci/mappable-labels/providers/{type}/{providerId}/connection | Get labels provider credentials | READ |
GET /api/v1/aci/mappable-labels/providers/labels-hierarchy | Get labels providers sorted in hierarchy order | READ |
GET /api/v1/aci/mappable-labels/labels | Get labels matching a query | READ |
GET /api/v1/aci/sc/configs | Get configurations of all active sensitivity groups | READ |
GET /api/v1/aci/sc/configs/{id} | Get sensitivity group configuration by group ID | READ |
POST /api/v1/aci/sc/configs/trigger-bootstrap | Trigger manual bootstrap for specific data sources | WRITE |
GET /api/v1/aci/sc/ratio | Get count of classified vs. unclassified objects | READ |
GET /api/v1/aci/sc/ratio/name/{name} | Get classified objects by sensitivity level (by name) | READ |
GET /api/v1/aci/sc/ratio/id/{id} | Get classified objects by sensitivity level (by ID) | READ |
GET /api/v1/aci/objects/distinct-sources | Get distinct data sources | READ |
GET /api/v1/aci/data-manager | List file annotations | READ |
GET /api/v1/aci/data-manager/count | Get annotation count | READ |
GET /api/v1/aci/data-manager/file-download/csv | Export annotations as CSV | READ |
GET /api/v1/aci/data-manager/permissions/file-download/csv | Export annotations with permissions as CSV | READ |
GET /api/v1/aci/data-manager/{fullyQualifiedName}/permissions | Get file permissions by fully qualified name | READ |
GET /api/v1/aci/dashboard | Get dashboard data | READ |
GET /api/v1/aci/dashboard/latest-ds-summaries | Get latest data source summaries | READ |
GET /api/v1/aci/dashboard/userWidgets | Get user widget data | READ |
GET /api/v1/aci/dashboard/any-ds-in-progress | Check if any data source scan is in progress | READ |
GET /api/v1/aci/continuous-labeling/settings | Get labeling propagation settings | READ |
GET /api/v1/aci/labeling-dashboard/propagation | Get labeling dashboard propagation | READ |
GET /api/v1/aci/labeling-dashboard/status | Get labeling dashboard status | READ |
GET /api/v1/aci/sensitivity-classification/status | Get sensitivity classification status | READ |
Catalog
| Route | Summary | Type |
|---|---|---|
GET /data-catalog | Get catalog objects with filtering and pagination | READ |
POST /data-catalog/ai/interpret | AI interpret catalog query | READ |
GET /data-catalog/columns | Get catalog columns | READ |
GET /data-catalog/count | Get catalog object count | READ |
GET /data-catalog/distinct-values/{fieldName} | Get distinct field values | READ |
GET /data-catalog/file-download/export | Export catalog data | READ |
POST /data-catalog/filters | Create filter | WRITE |
GET /data-catalog/glossary/objects | Get glossary objects | READ |
GET /data-catalog/glossary/objects/{id} | Get glossary object by ID | READ |
GET /data-catalog/health | Get data catalog health status | READ |
GET /data-catalog/insights | Get catalog insights | READ |
GET /data-catalog/object-details | Get object details | READ |
GET /data-catalog/object-details/attributes | Get object attributes | READ |
GET /data-catalog/object-details/columns | Get object column details | READ |
GET /data-catalog/object-details/columns/column-profile | Get column profile | READ |
GET /data-catalog/object-details/columns/count | Get column count | READ |
GET /data-catalog/object-details/fields | Get object field details | READ |
GET /data-catalog/object-summary | Get object summary statistics | READ |
GET /data-catalog/objects-with-pii/{source} | Get objects with PII by source | READ |
GET /data-catalog/objects/zip | Download objects as ZIP | READ |
GET /data-catalog/preview/{fullyQualifiedName} | Get file preview | READ |
POST /data-catalog/preview/{fullyQualifiedName} | Create file preview | WRITE |
GET /data-catalog/preview/investigation/{investigationId} | Get file investigation | READ |
GET /data-catalog/results-tuning/attributes | Get results tuning attributes | READ |
GET /data-catalog/results-tuning/attributes/categories | Get attribute categories | READ |
GET /data-catalog/results-tuning/curation-fields | List curation fields | READ |
POST /data-catalog/results-tuning/curation-fields/attributes | Get curation fields attributes | READ |
GET /data-catalog/results-tuning/curation-fields/grid/filters | Get available filter values for curation fields grid | READ |
GET /data-catalog/results-tuning/curation-fields/status/attribute | Get curation status grouped by attribute | READ |
GET /data-catalog/results-tuning/curation-fields/status/field | Get curation status grouped by field | READ |
GET /data-catalog/results-tuning/curation-fields/status/source | Get curation status grouped by data source | READ |
GET /data-catalog/results-tuning/curation-fields/{id} | Get curation field by ID | READ |
GET /data-catalog/results-tuning/sources-all | Get all results tuning sources | READ |
GET /data-catalog/results-tuning/sources/{scanId} | Get results tuning sources by scan ID | READ |
GET /data-catalog/rules | Get all rules | READ |
GET /data-catalog/scan-result-fetch-findings | Get scan result fetch findings | READ |
POST /data-catalog/scan-result-fetch-findings | Create scan result fetch findings | WRITE |
POST /data-catalog/scan-result-fetch-findings/preview/async | Create async preview job | WRITE |
POST /data-catalog/scan-result-fetch-findings/preview/job | Create preview job | WRITE |
POST /data-catalog/scan-result-fetch-findings/results | Get findings results | READ |
GET /data-catalog/scan-result-fetch-findings/{id} | Get scan result fetch finding by ID | READ |
POST /data-catalog/scan-result-fetch-findings/{id} | Update scan result fetch finding | WRITE |
GET /data-catalog/side-filter/cloud-types | Get cloud types filter | READ |
GET /data-catalog/side-filter/file-types | Get file types filter | READ |
GET /data-catalog/sync-control/last-update-at/{entityType} | Get last sync update time | READ |
GET /data-catalog/system-attributes | Get system attributes | READ |
GET /data-catalog/tables | Get catalog tables | READ |
GET /data-catalog/tags | Get all tags | READ |
GET /data-catalog/tags/all-pairs-ds | Get all tag pairs by data source | READ |
GET /data-catalog/tags/{tagId} | Get tag by ID | READ |
POST /data-catalog/validate-query | Validate query | READ |
Classification
| Route | Summary | Type |
|---|---|---|
GET /all-classifications | Get all classifiers (including custom) | READ |
GET /all-classifications/{classifierId} | Get classifier by ID | READ |
GET /classifications | Get all classifications | READ |
POST /classifications/exclude-list | Create exclude list item | WRITE |
GET /classifications/exclude-list | Get classification exclude list | READ |
GET /classifications/{classificationName} | Get classification by name | READ |
GET /classifiers | Get a list of available classifiers and advanced classifiers | READ |
GET /classifiers-categories | Get classifiers categories | READ |
Connectivity
| Route | Summary | Type |
|---|---|---|
GET /ds-connections | List all data sources | READ |
POST /ds-connections | Query data sources with body filters | READ |
POST /ds_connections | Create a new data source | WRITE |
GET /ds-connections-types | Get all supported data source types | READ |
GET /ds-connections-types/template/{dsType} | Get template for data source type | READ |
GET /ds-connections/file-download/export | Export data sources to file | READ |
GET /ds-connections/filters/values | Get available filter values for data source fields | READ |
GET /ds-connections/{connectionName}/connection-results | Get connection test results for a data source | READ |
GET /ds-connections/{connectionName}/test-status | Poll connection test progress | READ |
DSPM (Data Security Posture Management)
| Route | Summary | Type |
|---|---|---|
GET /actionable-insights/cases-by-severity | Get security issue cases grouped by severity | READ |
GET /actionable-insights/all-cases | Get all security issue cases (filtered/paginated) | READ |
GET /actionable-insights/cases-group-by-policy | Get security issue cases grouped by policy | READ |
GET /actionable-insights/cases-metadata | Get distinct values for all filterable case fields | READ |
GET /actionable-insights/top-critical-cases | Get top five most critical open cases | READ |
GET /actionable-insights/trends | Get security issue case trends over the last 30 days | READ |
DSAR
| Route | Summary | Type |
|---|---|---|
GET /correlation-set-connections | Get correlation set connections | READ |
GET /sar/attributes | Get SAR attributes | READ |
GET /sar/audit | Get SAR audit logs | READ |
GET /sar/file-download/audit | Download SAR audit logs | READ |
GET /sar/deletion-validations | Get deletion validations | READ |
GET /sar/deletion-validations/config | Get deletion validation configuration | READ |
GET /sar/general-info | Get general SAR configuration and information | READ |
GET /sar/profiles | Get SAR profiles | READ |
GET /sar/profiles/{profileId} | Get SAR profile by ID | READ |
GET /sar/report-templates | Get report templates | READ |
GET /sar/reports/{requestId} | Get SAR report by request ID | READ |
GET /sar/reports/{requestId}/extended-info | Get extended information for a SAR request | READ |
GET /sar/reports/{requestId}/personal-info | Get personal information for a SAR request | READ |
GET /sar/reports/{requestId}/searched-attributes | Get searched attributes for a SAR request | READ |
GET /sar/reports/{requestId}/short-report | Get short summary report | READ |
GET /sar/reports/file-download/{requestId} | Download the complete SAR report | READ |
GET /sar/reports/file-download/{requestId}/short-report | Download short report file | READ |
GET /file-download/sar/reports/{requestId}/summary-report | Download summary report | READ |
GET /sar/scans | Get SAR scans | READ |
GET /sar/scans/{requestId} | Get SAR scan by request ID | READ |
GET /sar/search/entity-source-connections/{profileId} | Get entity source connections by profile | READ |
Data Mapping
| Route | Summary | Type |
|---|---|---|
GET /data-mapping/profiles | Retrieve all DSAR profiles | READ |
GET /data-mapping/profiles/{profileId} | Retrieve a specific DSAR profile | READ |
GET /data-mapping/profiles/{profileId}/correlation-set-connections | Retrieve correlation set connections for a profile | READ |
POST /data-mapping/profiles/{profileId}/correlation-set-connections | Add correlation set connections to a profile | WRITE |
GET /data-mapping/profiles/{profileId}/data-sources | Retrieve data sources for a profile | READ |
POST /data-mapping/profiles/{profileId}/data-sources | Add data sources to a profile | WRITE |
GET /data-mapping/profiles/{profileId}/objects | Retrieve all objects in a profile | READ |
GET /data-mapping/profiles/{profileId}/objects/columns | Retrieve column definitions for objects in a profile | READ |
GET /data-mapping/profiles/{profileId}/statistics | Retrieve statistics for a profile | READ |
GET /privacy-apps/pia/bigid/assets | Get assets | READ |
GET /privacy-apps/pia/bigid/assets/attributes | Get asset attributes and categories | READ |
GET /privacy-apps/pia/bigid/assets/data-sources | Get data sources by asset | READ |
GET /privacy-apps/pia/bigid/vendors | Get vendor projects | READ |
GET /privacy-apps/pia/bigid/vendors/{vendorProjectId} | Get vendor project description by ID | READ |
GET /privacy-apps/pia/bigid/legal-entities | Get legal entities | READ |
GET /privacy-apps/pia/bigid/legal-entities/{entityId} | Get legal entity by ID | READ |
GET /regulations | Get all data categories | READ |
GET /regulations-aggregation | Get regulations aggregation | READ |
GET /compliance-frameworks | Get all compliance frameworks | READ |
GET /compliance-frameworks/{id} | Get compliance framework by ID | READ |
Labels
| Route | Summary | Type |
|---|---|---|
GET /labels | Get all labels | READ |
GET /labels/{labelName} | Get label by name | READ |
Lineage
| Route | Summary | Type |
|---|---|---|
GET /api/v1/lineage/tree | Get all lineage nodes showing collection relationships | READ |
Overview & Reporting
| Route | Summary | Type |
|---|---|---|
POST /executive-dashboard/widget | Fetch executive dashboard widget data | READ |
POST /data-explorer/objects | Get data explorer objects (all types) | READ |
POST /data-explorer/objects/{entityType} | Get data explorer objects by type | READ |
POST /data-explorer/count | Get data explorer count (all types) | READ |
POST /data-explorer/count/{entityType} | Get data explorer count by entity type | READ |
POST /inventory | Query data inventory with aggregations | READ |
GET /inventory/file-download/export/attribute | Export inventory by attribute | READ |
GET /inventory/file-download/export/source | Export inventory by source | READ |
POST /inventory/{entityType} | Query inventory aggregations filtered by entity type | READ |
GET /metadata-search/entity-types | Get all entity types | READ |
GET /metadata-search/entity-types/{entityType} | Get entity type details | READ |
POST /metadata-search/filter | Filter metadata search results | READ |
POST /metadata-search/filter/suggest | Get filter suggestions | READ |
GET /metadata-search/health-check | Health check for metadata search service | READ |
POST /metadata-search/index-by-filter/{entityType} | Index objects matching a filter | WRITE |
GET /metadata-search/report/{dataSourceName} | Get data source report | READ |
POST /metadata-search/search/full | Full metadata search | READ |
POST /metadata-search/search/quick | Quick metadata search | READ |
GET /metadata-search/status | Get indexing status | READ |
GET /metadata-search/stored-events/status | Get stored events status | READ |
POST /metadata-search/sync/update-object | Update a specific object in the search index | WRITE |
PII Records
| Route | Summary | Type |
|---|---|---|
GET /piiRecords | Get PII records with RBAC filtering | READ |
GET /identityLocations | Get identity locations with PII record counts | READ |
GET /systemLocations | Get system locations by data source | READ |
GET /applicationLocations | Get application locations by data source | READ |
GET /applicationRisks | Get risk data by application | READ |
GET /attributeRisks | Get risk data by attribute | READ |
GET /activityViolations | Get activity violation information | READ |
Policies
| Route | Summary | Type |
|---|---|---|
GET /compliance-rules | Get compliance policies | READ |
GET /compliance-rules/{ruleId} | Get a single policy by ID | READ |
GET /compliance-rules/{policyFqdn}/mapped-controls | Get compliance framework controls mapped to a policy | READ |
GET /acm-rules | List ACM rules | READ |
GET /acm-rules/{ruleName} | Get ACM rule by name | READ |
GET /complianceSummaries | Get compliance summaries | READ |
Privacy Risks
| Route | Summary | Type |
|---|---|---|
GET /privacy-risks | List privacy risks | READ |
GET /privacy-risks/search-metadata | Get privacy risks search metadata | READ |
GET /privacy-risks/{policyFqdn}/mapped-controls | Get compliance controls mapped to a privacy risk | READ |
GET /controls | Get all controls (risk and compliance) | READ |
GET /risk-controls | Get all risk controls | READ |
ROPA / PIA
| Route | Summary | Type |
|---|---|---|
GET /privacy-apps/pia/base-templates/metadata | Get all base templates metadata | READ |
GET /privacy-apps/pia/base-templates/{id} | Get base template by ID | READ |
GET /privacy-apps/pia/templates/metadata | Get all custom templates | READ |
GET /privacy-apps/pia/templates/{id} | Get custom template by ID | READ |
GET /privacy-apps/pia/templates/{id}/metadata | Get template metadata by ID | READ |
GET /privacy-apps/pia/templates/{id}/instances | Get total number of assessments for a template | READ |
GET /privacy-apps/pia/templates/counts | Get all custom template counts | READ |
GET /privacy-apps/pia/templates/types | Get template types | READ |
GET /privacy-apps/pia/templates/search-filters | Get search template filters | READ |
POST /privacy-apps/pia/templates/search | Create search templates | WRITE |
GET /privacy-apps/pia/instances/{id} | Get assessment by ID | READ |
GET /privacy-apps/pia/instances/{id}/metadata | Get assessment metadata by ID | READ |
GET /privacy-apps/pia/instances/{id}/fields/{fieldId}/general-data | Get assessment field general data | READ |
GET /privacy-apps/pia/instances/{id}/collaborators | Get collaborators for assessment | READ |
GET /privacy-apps/pia/instances/search/base | Get search assessment for base grid | READ |
GET /privacy-apps/pia/instances/search-filters | Get search filters | READ |
GET /privacy-apps/pia/instances/export/{templateId} | Get exported privacy impact assessments | READ |
GET /privacy-apps/pia/instances/export/{templateId}/template | Export PIA template | READ |
POST /privacy-apps/pia/instances/search | Create search assessment | WRITE |
GET /privacy-apps/pia/reports/instance-overview/{id} | Get assessment overview report | READ |
GET /privacy-apps/ropa/reports/instance-report/{id} | Get ROPA assessment overview report | READ |
GET /privacy-apps/pia/collaboration/health | Check collaboration service health | READ |
GET /privacy-apps/pia/collaboration/version | Get collaboration service version | READ |
GET /privacy-apps/pia/collaboration/version/api-version | Get collaboration service API version | READ |
GET /privacy-apps/pia/collaboration/{collaborationId}/instance-id | Get instance ID by collaboration ID | READ |
GET /privacy-apps/pia/collaboration/collaborations/comments | Get comments for instance or field | READ |
GET /privacy-apps/pia/collaboration/collaborations/{instanceId}/comments:countByField | Get total comments per field | READ |
GET /privacy-apps/pia/collaboration/collaborations/comments/status | Get comment status for the user | READ |
GET /privacy-apps/pia/assignments/{id} | Get assignment | READ |
GET /privacy-apps/pia/permissions | Get permissions | READ |
GET /privacy-apps/pia/settings/collaboration | Get collaboration settings | READ |
GET /privacy-apps/pia/settings/configuration | Get configuration settings | READ |
GET /privacy-apps/pia/feature-flags | Fetch feature flags | READ |
GET /privacy-apps/pia/risks | Get all privacy risks | READ |
GET /privacy-apps/pia/risks/{riskId} | Get risk by ID | READ |
GET /privacy-apps/pia/risks/metadata | Get risk search metadata | READ |
GET /privacy-apps/pia/risks/summary/{instanceId} | Get risk summary by assessment ID | READ |
POST /privacy-apps/pia/risks/bulk-delete | Bulk delete risks by list of IDs | WRITE |
GET /privacy-apps/pia/controls | Get all controls | READ |
Scan Management
| Route | Summary | Type |
|---|---|---|
GET /scans | List all scans | READ |
GET /scans/parent-scans | Get parent scans | READ |
GET /scans/child-scans/{parentScanId} | Get child scans | READ |
GET /scanProfiles/{id} | Get a scan profile by ID | READ |
GET /scan-templates | Get all scan templates | READ |
GET /scan-templates/{scanTemplateId} | Get a scan template by ID | READ |
Configurations
| Route | Summary | Type |
|---|---|---|
GET /services-configuration | Get BigID services configuration settings | READ |
GET /audit-log | Get audit log data | READ |
GET /audit-log/scope/{scopeName} | Get audit logs by scope | READ |
GET /saved-queries | Get all saved queries | READ |
GET /saved-queries/{savedQueryId} | Get saved query by ID | READ |
POST /saved-queries | Create saved query | WRITE |
Data Retention
| Route | Summary | Type |
|---|---|---|
GET /api/v1/policies | Get retention policies | READ |
POST /api/v1/policies | Create a new retention policy | WRITE |
GET /api/v1/policies/{id} | Get retention policy by ID | READ |
PUT /api/v1/policies/{id} | Update a retention policy | WRITE |
DELETE /api/v1/policies/{id} | Delete a retention policy | WRITE |
POST /api/v1/policies/{id}/evaluate | Start evaluation of a policy | WRITE |
GET /api/v1/policies/statistics | Get policy statistics | READ |
GET /api/v1/policies/names | Get policy names | READ |
GET /api/v1/policies/domains | Get policies grouped by domain | READ |
GET /api/v1/policies/export | Export policies to CSV | READ |
POST /api/v1/policies/import | Import policies from CSV | WRITE |
GET /api/v1/policies/import/template | Download CSV import template | READ |
POST /api/v1/policies/evaluate | Evaluate policies by filter criteria | WRITE |
POST /api/v1/policies/clone | Clone existing retention policies | WRITE |
GET /api/v1/policies/actions | Get available policy actions | READ |
GET /api/v1/policies/query | Get queries for policy hits | READ |
GET /api/v1/policies/{id}/definitions | Get all policy definitions for a policy | READ |
POST /api/v1/policies/{id}/test-catalog-based | Test catalog-based policy definition | WRITE |
POST /api/v1/policies/{id}/test-query-based | Test query-based policy definition | WRITE |
POST /api/v1/policies/{id}/test-header-table | Test entity-based policy definition | WRITE |
POST /api/v1/policies/{id}/test-regular-table | Test table-based policy definition | WRITE |
GET /api/v1/policies/evaluations | Get policy evaluations | READ |
POST /api/v1/policies/evaluations/stop | Stop policy evaluations | WRITE |
POST /api/v1/policies/evaluations/{policyEvaluationId}/resume | Resume a stopped policy evaluation | WRITE |
GET /api/v1/policy-hits | Get policy hits | READ |
GET /api/v1/policy-hits/sample-data | Get policy hit sample data | READ |
GET /api/v1/findings | Get finding objects | READ |
GET /api/v1/findings/count | Get findings count | READ |
GET /api/v1/findings/by-data-sources | Get findings grouped by data sources | READ |
GET /api/v1/findings/datasources | Get distinct data source names | READ |
GET /api/v1/findings/statistics-by-date | Get findings statistics grouped by date | READ |
GET /api/v1/findings/file-download/export | Export findings to CSV | READ |
POST /api/v1/findings/send-findings | Send findings to Remediation | WRITE |
POST /api/v1/findings/send-to-deletion | Send findings to Deletion | WRITE |
GET /api/v1/activity-logs | Get activity logs | READ |
GET /api/v1/activity-logs/actions | Get distinct activity log actions | READ |
GET /api/v1/activity-logs/item-names | Get distinct activity log item names | READ |
GET /api/v1/activity-logs/item-types | Get distinct activity log item types | READ |
GET /api/v1/disposition-tasks | Get disposition tasks | READ |
GET /api/v1/policy-evaluation-schedule | Get policy evaluation schedules | READ |
PATCH /api/v1/policy-evaluation-schedule | Update policy evaluation schedules | WRITE |
DELETE /api/v1/policy-evaluation-schedule/{policyId} | Cancel a policy evaluation schedule | WRITE |
GET /api/v1/policy-associations/{policyId} | Get associated policies | READ |
PUT /api/v1/policy-associations | Create a policy association | WRITE |
DELETE /api/v1/policy-associations | Remove a policy association | WRITE |
GET /api/v1/data-sources | Get data sources from BigID Core | READ |
GET /api/v1/data-sources/connector-types | Get data source connector types | READ |
POST /api/v1/data-sources/search | Search data sources | READ |
GET /api/v1/settings/criticalities | Get criticalities | READ |
POST /api/v1/settings/criticalities | Create a criticality | WRITE |
PUT /api/v1/settings/criticalities/{id} | Update a criticality | WRITE |
DELETE /api/v1/settings/criticalities/{id} | Delete a criticality | WRITE |
GET /api/v1/settings/domains | Get domains | READ |
POST /api/v1/settings/domains | Create a domain | WRITE |
PUT /api/v1/settings/domains/{id} | Update a domain | WRITE |
DELETE /api/v1/settings/domains/{id} | Delete a domain and its subdomains | WRITE |
GET /api/v1/settings/environments | Get environments | READ |
POST /api/v1/settings/environments | Create an environment | WRITE |
PUT /api/v1/settings/environments/{id} | Update an environment | WRITE |
DELETE /api/v1/settings/environments/{id} | Delete an environment | WRITE |
GET /api/v1/settings/jurisdictions | Get jurisdictions | READ |
POST /api/v1/settings/jurisdictions | Create a jurisdiction | WRITE |
PUT /api/v1/settings/jurisdictions/{id} | Update a jurisdiction | WRITE |
DELETE /api/v1/settings/jurisdictions/{jurisdictionId} | Delete a jurisdiction | WRITE |
GET /api/v1/settings/regulations | Get regulations | READ |
POST /api/v1/settings/regulations | Create a regulation | WRITE |
PUT /api/v1/settings/regulations/{id} | Update a regulation | WRITE |
DELETE /api/v1/settings/regulations/{id} | Delete a regulation | WRITE |
GET /api/v1/application-settings | Get application settings and feature flags | READ |
GET /api/v1/system-status | Get system status report | READ |
GET /api/v1/system-users | Get system users | READ |
GET /api/v1/system-users/{userId} | Get system user by ID | READ |
GET /api/v1/stream/sse-retention | Subscribe to retention SSE events | READ |
Data Deletion
| Route | Summary | Type |
|---|---|---|
GET /api/v1/data-minimization/requests | Get all data minimization requests | READ |
DELETE /api/v1/data-minimization/requests/{requestId} | Delete a data minimization request | WRITE |
POST /api/v1/data-minimization/requests/expire-requests | Expire data minimization requests | WRITE |
GET /api/v1/data-minimization/requests/insights | Get request insights | READ |
GET /api/v1/data-minimization/objects | Get all data minimization objects | READ |
POST /api/v1/data-minimization/objects | Create data minimization objects | WRITE |
PUT /api/v1/data-minimization/objects | Update data minimization objects | WRITE |
DELETE /api/v1/data-minimization/objects | Delete data minimization objects | WRITE |
GET /api/v1/data-minimization/objects/file-download/export | Export data minimization objects to CSV | READ |
POST /api/v1/data-minimization/objects/action | Update action status for data minimization objects | WRITE |
POST /api/v1/data-minimization/objects/execute | Execute objects marked as Delete Automatically | WRITE |
GET /api/v1/data-minimization/objects/execute/count | Get count of objects to be executed (GET) | READ |
POST /api/v1/data-minimization/objects/execute/count | Get count of objects to be executed (POST) | READ |
POST /api/v1/data-minimization/objects/count | Get count of objects | READ |
POST /api/v1/data-minimization/objects/execute-async | Execute objects marked as Delete Automatically (async) | WRITE |
DELETE /api/v1/data-minimization/objects/async | Delete data minimization objects (async) | WRITE |
GET /api/v1/data-minimization/datasources | Get all data minimization data sources | READ |
DELETE /api/v1/data-minimization/datasources | Delete data minimization data sources | WRITE |
POST /api/v1/data-minimization/datasources/execute | Execute deletion for data sources | WRITE |
POST /api/v1/data-minimization/datasources/objects/count | Get count of objects per data source | READ |
GET /api/v1/data-minimization/datasource-state | Get data source state | READ |
GET /api/v1/data-minimization/datasources/error-mappings | Get error mappings for data sources | READ |
GET /api/v1/data-minimization/datasources/file-download/export | Export data sources to CSV | READ |
GET /api/v1/data-minimization/datasources/errors/file-download/export | Export data source errors to CSV | READ |
GET /api/v1/data-minimization/datasources/objects/file-download/export | Export data source objects to CSV | READ |
GET /api/v1/data-minimization/datasources/objects/failed/file-download/export | Export failed object samples to CSV | READ |
GET /api/v1/data-minimization/datasources/insights | Get insights for data sources | READ |
DELETE /api/v1/data-minimization/datasources/async | Delete data minimization data sources (async) | WRITE |
GET /api/v1/data-minimization/executions | Get data deletion executions | READ |
POST /api/v1/data-minimization/executions/{executionId}/stop | Stop a running execution | WRITE |
GET /api/v1/data-minimization/disposition-tasks | Get all disposition tasks | READ |
DELETE /api/v1/data-minimization/disposition-tasks | Cancel disposition tasks | WRITE |
POST /api/v1/data-minimization/disposition-tasks/execute | Execute deletion for disposition tasks | WRITE |
GET /api/v1/data-minimization/disposition-tasks/actions | Get distinct disposition task actions | READ |
GET /api/v1/data-minimization/disposition-tasks/policies | Get distinct disposition task policies | READ |
GET /api/v1/data-minimization/dsar-queries | Get DSAR queries for deletion | READ |
GET /api/v1/data-minimization/settings/objects | Get data minimization global settings | READ |
POST /api/v1/data-minimization/settings/objects | Update data minimization global settings | WRITE |
DELETE /api/v1/data-minimization/settings/objects | Delete data minimization global settings | WRITE |
POST /api/v1/data-minimization/support/datasources | Check if data sources support auto-deletion | READ |
POST /api/v1/data-minimization/states/by-datasources | Get deletion states by request ID and data sources | READ |
GET /api/v1/data-minimization/error-mappings/categories | Get error mapping categories | READ |
POST /api/v1/data-minimization/statistics | Get data minimization statistics | READ |
POST /api/v1/data-minimization/execute | Execute data minimization deletion | WRITE |
GET /api/v1/data-minimization/status | Get data minimization app status | READ |
GET /api/v1/data-minimization/manifest | Get data minimization manifest | READ |
Example Prompts
Section titled “Example Prompts”The following natural language prompts illustrate what you can accomplish by connecting Claude to the BigID MCP server.
Discover Data Sources and Their Security Posture
Section titled “Discover Data Sources and Their Security Posture”Show me the security posture of all my data sources in BigID.Highlight critical risks and exposed sensitive data.Discover Shadow AI
Section titled “Discover Shadow AI”What AI assets, AI applications, and unsanctioned AI usage existacross my organization according to BigID?Breach Investigation Report
Section titled “Breach Investigation Report”Investigate a potentially compromised account in BigID. Pull data accesshistory, entitlements, and sensitive data exposure, then generate arisk-rated incident report with remediation actions.Find Cleartext Passwords and Secrets
Section titled “Find Cleartext Passwords and Secrets”Find repositories, files, or databases containing exposed secrets, API keys,tokens, certificates, or cleartext passwords in BigID.GDPR Readiness Assessment
Section titled “GDPR Readiness Assessment”Evaluate our GDPR readiness in BigID. Identify personal data exposure,missing retention policies, cross-border data risks, and DSAR compliance gaps.Data Retention Cleanup
Section titled “Data Retention Cleanup”Identify stale, duplicate, or unnecessary sensitive data in BigIDthat should be archived or deleted.All rights reserved.