Source
Integrations & automation — found from sitemap — BigID
Checked for BigID on 13 Oct 2026
- Page
- https://developer.bigid.com/connectors/writing-a-rest-connector/
- Checked
- 13 Oct 2026, 10:26 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:0c4c4dfd08b9ffc2a91b3b3d2b69515e8688d91b0ffac629d8b0c44f187495ad
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Rest connector languages Report an error
“External REST Connectors allow you to write integrations in any programming language. As long as your service can respond to HTTP requests in the format BigID expects, the BigID scanner will be able to map, catalog, and classify your custom data.”
-
Structured connector endpoints Report an error
“BigID will request and view your connector’s hierarchy through six endpoints: List what fields an object has (GET /objects/<objectName>/describe) List what objects exist (/objects) List what records are inside an object (GET /objects/<objectName>/records) Count the number of records inside an object (GET /objects/<objectName>/count) Return the fields and values for a given record ID (GET /objects/<objectName>/<recordID>) Search for records in an object (POST /objects/<objectName>/sar)”
-
Dsar minimal endpoints Report an error
“If you want a connector that only does DSAR requests you only need to implement the following endpoints: List what objects exist (/objects) List what fields an object has (GET /objects/<objectName>/describe) Search for records in an object (POST /objects/<objectName>/sar)”
-
Pagination params Report an error
“To handle these use cases, BigID has two properties on the records endpoint: Count and Offset. Count dictates the batch size. This is how many records your connector should return in a single call. This allows BigID users to throttle your connector based on how many records it returns per page. Offset allows BigID to paginate requests.”
-
Credential storage Report an error
“BigID has the ability to store and manage these credentials for you inside of the BigID system or use credentials from external password vaults. When a scan is started, BigID will send the credentials to your connector.”
-
Auth format examples Report an error
“OAuth Client Credentials - Username: https://tenanturl.com/,CLIENT_ID Password: CLIENT_SECRET Multi Tenant SaaS application with API key - Username: tenantID Password: API_KEY SaaS application with just an API key - Username: <blank> Password: API_KEY”
-
Unstructured connector endpoints Report an error
“BigID will request and view your connector’s hierarchy through six endpoints: List what Containers exist (/objects) List what Objects exist (/objects/<containerName>?Offset=) Return the Metadata for a given object (GET /objects/<containerName>/<objectName>/describe) Return the InputStream for a given object (GET /objects/<containerName>/<objectName>/content-stream) Search for specific data inside objects (POST /objects/<containerName>/<objectName>/sar?Offset=)”
-
Connector distribution docker Report an error
“BigID connectors are distributed as Docker images. This allows them to be run within the BigID app server Kubernetes cluster or on the Kubernetes clusters and Docker compose servers running an organization’s scanners.”
-
Swaggerfiles available Report an error
“If you’re using code generation software, or just want it for your own purposes, the swaggerfile describing a structured connector is available here.”
-
Sar capable field Report an error
“sarCapable refers to whether an unstructured data source could be processed as structured data. This means BigID will ignore the actual file contents and only use structured fields defined here. It should not be set to true for any file you want to perform SARs on, especially if you want BigID to classify the file content.”
-
Custom fields Report an error
“The custom fields object allows you to add your own!”
2 facts read from this page are not shown because they could not be confirmed on the page as captured.
Scores citing this record
- The Drafted Generalist Integrations & automation
- The Drafted Generalist European sovereignty
- The External DPO Pricing transparency
- The External DPO Integrations & automation
- The External DPO European sovereignty
- The In-House Counsel Records & DPIA depth
- The In-House Counsel Integrations & automation
- The In-House Counsel European sovereignty
- The IT Integrator Pricing transparency
- The IT Integrator Integrations & automation
- The IT Integrator European sovereignty
- The Lead Auditor Integrations & automation
- The Skeptic Pricing transparency
- The Skeptic Data subject rights & incidents
- The Skeptic Integrations & automation
- The Skeptic European sovereignty