Connectors

Connect external storage providers to import documents into the dataroom. Supported providers: Google Drive, OneDrive, SharePoint, Dropbox, and Amazon S3. See the Connector provider and Connection status values in the overview.

OAuth provider redirect callback

GET

/connectors/oauth/{provider}/callback

Browser navigations (Accept: text/html) are redirected back to the frontend dataroom page with ?connector={id} on success or ?connector_error={message} on failure; other clients receive the ConnectionSummary JSON.

Parameters

Path Parameters

provider*

Type

string

Required

Query Parameters

code

state

error

error_description

display_name

site_id

SharePoint site ID (required for sharepoint OAuth callback)

Responses

Successful Response

Content-Type

application/json

[

]

Samples

List connections

GET

/v1/connectors/connections

List the caller's connections to external storage providers, each with its
current status.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"can_save": false,

  

  

  

"config": {

  

  

  

  

"additionalProperties": "string"

  

  

  

},

  

  

  

"created_at": "string",

  

  

  

"credentials_masked": {

  

  

  

  

"additionalProperties": "string"

  

  

  

},

  

  

  

"display_name": "string",

  

  

  

"id": "string",

  

  

  

"last_error": "string",

  

  

  

"provider": "string",

  

  

  

"status": "string",

  

  

  

"updated_at": "string",

  

  

  

"user_id": "string"

  

  

}

  

]

}

Samples

Delete a connection

DELETE

/v1/connectors/connections/{connection_id}

Delete a connection and its stored credentials. Documents already imported
through it stay in the dataroom.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

connection_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Samples

Get a connection

GET

/v1/connectors/connections/{connection_id}

Get one connection's detail, including which account it is linked to and its
current status.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

connection_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"can_save": false,

  

"config": {

  

  

"additionalProperties": "string"

  

},

  

"created_at": "string",

  

"credentials_masked": {

  

  

"additionalProperties": "string"

  

},

  

"display_name": "string",

  

"id": "string",

  

"last_error": "string",

  

"provider": "string",

  

"status": "string",

  

"updated_at": "string",

  

"user_id": "string"

}

Samples

Update a connection

PATCH

/v1/connectors/connections/{connection_id}

Update a connection's mutable fields, such as its display name or the folder
scope it imports from.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

connection_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

Any of

Any of

Any of

Min Length1

Responses

Successful Response

Content-Type

application/json

{

  

"can_save": false,

  

"config": {

  

  

"additionalProperties": "string"

  

},

  

"created_at": "string",

  

"credentials_masked": {

  

  

"additionalProperties": "string"

  

},

  

"display_name": "string",

  

"id": "string",

  

"last_error": "string",

  

"provider": "string",

  

"status": "string",

  

"updated_at": "string",

  

"user_id": "string"

}

Samples

Browse remote files

POST

/v1/connectors/connections/{connection_id}/browse

Browse the connected provider's file tree one level at a time, so a folder can
be picked before importing from it.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

connection_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

Default""

Responses

Successful Response

Content-Type

application/json

{

  

"files": [

  

  

{

  

  

  

"file_id": "string",

  

  

  

"is_folder": true,

  

  

  

"mime_type": "string",

  

  

  

"name": "string",

  

  

  

"path": "string",

  

  

  

"size_bytes": 0

  

  

}

  

],

  

"path": "string"

}

Samples

Download a remote file

GET

/v1/connectors/connections/{connection_id}/files/{file_id}/download

Stream a single file from the connected provider. Capped at 10 MB.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

connection_id*

Type

string

Required

Format

"uuid"

file_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

"string"

Samples

Re-validate a connection

POST

/v1/connectors/connections/{connection_id}/refresh

Re-validate the stored credentials for a connection and update its status.
Use it after a provider-side change to check whether the connection still works.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

connection_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"can_save": false,

  

"config": {

  

  

"additionalProperties": "string"

  

},

  

"created_at": "string",

  

"credentials_masked": {

  

  

"additionalProperties": "string"

  

},

  

"display_name": "string",

  

"id": "string",

  

"last_error": "string",

  

"provider": "string",

  

"status": "string",

  

"updated_at": "string",

  

"user_id": "string"

}

Samples

List OAuth providers

GET

/v1/connectors/oauth/providers

List the storage providers available for an OAuth connection, and whether each
is configured on this deployment.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"providers": [

  

  

{

  

  

  

"label": "string",

  

  

  

"provider": "string"

  

  

}

  

]

}

Samples

Start an OAuth flow

GET

/v1/connectors/oauth/{provider}/authorize

Begin an OAuth flow for a storage provider and return the URL to send the user
to. The callback completes the connection.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

provider*

Type

string

Required

Valid values

"google_drive""dropbox""onedrive""sharepoint"

Query Parameters

login_hint

Email hint passed to the provider consent screen

site_id

SharePoint site ID (required when provider is sharepoint)

return_to

Frontend path to return to after OAuth (e.g. /dataroom?folder=…)

Responses

Successful Response

Content-Type

application/json

{

  

"authorize_url": "string"

}

Samples

Create an S3 connection

POST

/v1/connectors/s3/connections

Create a connection to an Amazon S3 bucket from supplied credentials. S3 is
credential-based rather than OAuth, so no browser flow is involved.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

S3 config: bucket, optional prefix, optional HTTPS endpoint_url.

S3 credentials: access_key_id, secret_access_key, optional region.

Min Length1

Responses

Successful Response

Content-Type

application/json

{

  

"can_save": false,

  

"config": {

  

  

"additionalProperties": "string"

  

},

  

"created_at": "string",

  

"credentials_masked": {

  

  

"additionalProperties": "string"

  

},

  

"display_name": "string",

  

"id": "string",

  

"last_error": "string",

  

"provider": "string",

  

"status": "string",

  

"updated_at": "string",

  

"user_id": "string"

}

Samples