Skip to main content
POST
Start cloud file OAuth

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

provider
required

The cloud file provider to connect.

Allowed value: "google_drive"

Body

application/json

Request payload for starting a cloud file-service OAuth authorization.

Request payload for starting a cloud file-service OAuth authorization.

displayName
string
required

Human-readable name for the connection to be created on success.

Required string length: 1 - 255
root
string

Where to scope the sync: a folder id (Drive, OneDrive, Box) or a folder path (Dropbox). Omit to use the account root.

Required string length: 1 - 255

Response

The response to a successful authorization start: where to send the user.

The response to a successful authorization start: where to send the user.

authorizeUrl
string
required

The provider authorize URL the client should redirect the user to.