Create Embedded Connect Link

Create a single-use link for an end user to connect an app account. Requires the embedded:create permission and an explicitly configured single-app integration or access to any app.

POST

Path

Path parameters

stringrequired

The MindCloud userId saved for your signed-in application user.

Body

Arguments

string

A published app, by its id or slug from List Universal Apps.

The published app to connect, by its id or slug.

string

The older name of app, still accepted. Send one of the two.

The older name of app, still accepted.

string

An exact public connection ID owned by this end user. SDK accounts update in place. Provisioned accounts without an installation create a new SDK account; reload connections and use its new ID.

The exact public connection ID owned by this end user. SDK accounts update in place. Provisioned accounts without an installation create a new SDK account; reload connections and use its new ID.

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.