Create Connect Link

Connect an OAuth app (Google, Slack, HubSpot…), or reconnect an OAuth connection, through the person who owns the API key: they open the link signed in to MindCloud and sign in at the provider. The link works once, for fifteen minutes, and only for that person. The connection appears in List Connections once they finish; use name to find it (q=…). Apps that take an API key are connected directly with Create Connection.

POST

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

stringrequired

An app id or slug, from List Universal Apps.

The app to connect, by its id or slug, from List Universal Apps.

string

The sign-in method's id, from GET /v2/connections/fields. Left out: the app's default.

The sign-in method to use, for an app with more than one, from GET /v2/connections/fields. Left out: the app's default, or the connection's own on a reconnect.

booleanrequired

Required. true: shared with the organization. false: the API key creator's own.

Required. true: the connection is shared with the organization. false: it is the API key creator's own. On a reconnect, the connection's current value.

string

A name for the new connection. Left out: MindCloud names it after the account. Not taken on a reconnect.

The connection's name, as the app lists it. It cannot contain a secret of the connection.

string

To reconnect an existing connection: its id, from List Connections.

Reconnect this connection instead of creating one: its id, from List Connections.

Response fields

urlstring

Show this URL only to the person it is for: the end user, for an Embedded link; the person who created the API key, signed in to MindCloud, for Create Connect Link (only they can open it). The link lasts fifteen minutes and works once.

appNamestring

The app the user will connect.

expiresOndate

When the connection link expires.

singleUseboolean

Always true. Request a new link if this one was consumed.