The connection object

A connection represents an authorized link to a user’s Google Drive account. After a user grants access, you use the connection to import the files they select into the platform as assets.

The List connections and Retrieve a connection endpoints return connection objects. The platform never returns the access or refresh tokens of the connection.

Connection fields

A connection object has the following fields:

  • _id: The unique identifier of the connection. Use this value to retrieve the connection, generate a picker token, import files, or disconnect the account.
  • provider: The data connector provider (google_drive).
  • status: The status of the connection. See the Connection statuses section for details.
  • custom_id: The label you supplied when creating the connection. Present only if you supplied one.
  • account: Information about the connected provider account:
    • external_id: The identifier of the account at the provider. It does not change.
    • display_name: A human-readable label for the account, such as an email address.
  • scopes: The access scopes granted to the connection.
  • connected_at: The date and time, in the RFC 3339 format, when the connection was established.
  • last_used_at: The date and time, in the RFC 3339 format, when the connection was last used.

Connection statuses

The status field of a connection object has one of the following values:

  • active: The connection is authorized and ready to use.
  • expired: The authorization is no longer valid. Ask the user to reconnect the account.
  • revoked: The user or the provider revoked access. Ask the user to reconnect the account.

When a connection is not active, requests that use it, such as generating a picker token or importing files, fail with the connection_not_active error. Reconnect the account to restore access.