Deprecation of the BigID resource type
Retool is deprecating the dedicated BigID resource type.
Retool will remove the resource type in Q1 2027, after two quarterly Stable releases. After removal, BigID resources will stop working. Queries in apps and workflows that still point at those resources will fail. Cloud and self-hosted organizations will not have a BigID connection option after removal.
Organizations can keep querying BigID after removal by creating an OpenAPI or REST API resource. Retool will not migrate BigID resources or their query references automatically.
- Create an OpenAPI resource with specification URL
https://sandbox.apps.mybigid.com/BigAPI.yamlor theBigAPI.yamlURL for your BigID instance, andenvironmentserver variable set to your BigID hostname. For REST API, set the base URL tohttps://HOSTNAME/api/v1. - Set Authentication to Custom Auth. Add an API Request step that sends
POST /api/v1/refresh-access-tokenwith your BigID user token in theAuthorizationheader. Add a Define a variable step namedSYSTEM_TOKENwith value{{ http1.body.systemToken }}. Add anAuthorizationheader on the resource that uses{{ SYSTEM_TOKEN }}. Enable Run this custom auth workflow without prompting the user. Configure a refresh auth workflow that repeats the exchange after a non-200 response. Generate the user token in the BigID UI and exchange it as described in BigID's token authentication. - Open each app, workflow, and Query Library query that uses the BigID resource. Change the query to use the new resource, then test it. For OpenAPI, select the same operation. For REST API, recreate the request as method and path, such as
GET /ds-connections. If the OpenAPI query editor shows anAuthorizationparameter, leave it empty.
Custom authentication is not supported in public apps. If you have a large number of BigID queries and need help finding them, contact Retool Support.