Start the read-only file consent

GET

/v1/workspaces/{workspaceId}/file-imports/connect/{provider}

const url = 'https://shareout.site/v1/workspaces/example/file-imports/connect/google_drive';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shareout.site/v1/workspaces/example/file-imports/connect/google_drive \
  --header 'Authorization: Bearer <token>'

Redirects (302) to Google or Microsoft. The consent returns to GET /v1/file-imports/oauth/{provider}/callback, which stores the encrypted tokens for the signed-in member in this workspace and posts shareout:file-import:connected to the opener window.

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

provider

required

string

Allowed values: google_drive microsoft

Responses

302

Redirect to the provider’s consent screen

403

Access denied

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

404

Resource not found

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}