Connect a source
Configure a read-only adapter and verify reachability with a sample.
By the end you’ll be able to
- Configure an adapter's connection using its `preferredAuth` mode.
- Run a sample call against `/v1/adapters/:id/sample` and read the result.
- Know which env vars / grants the IT team needs to provision per adapter.
Connecting a source is a read-only operation: DataBridge needs least-privilege credentials, nothing more. The required shape depends on the adapter's `preferredAuth`. A `bearer` adapter (e.g. `sits-api`) needs a token. A `basic` adapter (e.g. `workday-raas`) needs a service account username + password. An `oauth2` adapter (e.g. `banner-ethos`, `colleague-ethos`, `unit4-student`, `techone-student`) needs a client id + secret and a token endpoint. A `db-credentials` adapter (e.g. `banner-oracle`, `peoplesoft-cs`, `callista`, `sjms5`) needs a read-only DB user. A `file` adapter (e.g. `sits-file`) needs an SFTP / S3 / upload drop.
All of this is documented per-adapter in `docs/CONNECTORS.md` — the env vars, the grants, and any vendor-specific gotchas (e.g. Workday RaaS report URL conventions, Ethos scope strings). The Integrations screen in the app surfaces the same information against each connected system.
Once configured, the single most useful operation is the sample. Every adapter implements `GET /v1/adapters/:id/sample` (wired in `apps/api/src/adapter-sample-registry.ts`) which pulls a small slice — usually a single resource, capped to a handful of rows. A successful sample proves four things at once: network reachability, credential validity, authorisation scope, and rough record shape. Run one before you trust the pipeline.
What you'll do in this lesson: open the Integrations screen, drill into a connected system, and inspect the sample / health area. In demo mode these screens render against seeded fixtures, so you can practise the workflow safely.
Walkthrough
- Open Integrations
1.Open Integrations
The Integrations screen lists every connected system in the demo. This is your home base for connect / sample / health workflows.
- Open a system
2.Drill into one system
Click into any connected system's detail page. Note the auth mode, the configured resources and any recent activity.
- Open Adapters
3.Review the adapter capabilities
Cross-reference what the system's adapter supports on the Adapters screen — that tells you whether a sample, an incremental sync and code-lists are available.
Your turn
Open the Integrations screen and drill into one connected source system in the demo. Confirm you can see its adapter id, its auth mode, and (where supported) where you'd trigger a sample.
Hint: The 'Open Integrations' step puts you in the right place; the system detail page links to its adapter.