The box connector reads a Box account through a Box Platform app. It runs Airbyte's Box connector definition inside the SDK.
| Connector name | box |
| Products | Records |
| Credentials | The portal's Connect button, or a Box app with Client Credentials Grant, and the user or enterprise it acts as |
| Definition | Airbyte's source-box manifest, version 0.0.22 (Elastic License 2.0) |
| Status | Preview: tested against Box's documented responses, not yet on a live account |
What it pulls
By default file, folder and user. Add file_collaboration, folder_collaboration, file_comment, sign_request, event or admin_log with objects.
The connector definition lists only the items in the root folder, not every subfolder. For a full file inventory, export Box's folder and file report to CSV and use the CSV connector.
Credentials
In the Box Developer Console, create a Platform app with Server Authentication (Client Credentials Grant) and the Read all files and folders scope; have a Box admin authorize it. Give the SDK clientId, clientSecret and the userId the app acts as, or set subjectType to enterprise and pass the enterprise id as userId.
Or skip the tokens: click Connect next to Box in the portal (Settings → Connected systems), then run datayield connect box --broker.
Connect
datayield connect box -o clientId=<client id> -o clientSecret=env:BOX_SECRET -o userId=<user id>Options
| Option | Required | Meaning |
|---|---|---|
clientId, clientSecret, userId |
yes, or accessToken |
The app and the user or enterprise it acts as |
subjectType |
no | user (default) or enterprise |
accessToken |
instead of the above | A current access token, for a one-off run |
objects |
no | Record types to pull |
New records on each run
Files, folders and users are sent whole each run. Collaborations, comments and events are kept when they changed between the last successful run and now.