Start connector login

Open a Reduck cloud browser at a site's sign-in page for a PERSON to sign into. Returns signInUrl, a Reduck page that shows the live browser — hand it to whoever holds the account on that site. When they sign in, the connector for each host is stored on its own; poll getConnectorLogin to see it land. Use this when there is no Reduck extension to upload cookies from. hosts defaults to the login URL's own site. The browser is created when the page is opened and lives ~10 minutes from then. With profile, the connectors are stored for that end-user; endUserLink then also answers endUserUrl, a page the end-user signs in on without a Reduck account. An end-user's sign-in never answers what they typed.

post/api/connectors/login

Request

  • Base URL: https://reduck.ai
  • URL: https://reduck.ai/api/connectors/login
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

loginUrlstring uri required
hostsstring[]
ssoboolean
ssoAccountstring
profilestring

The end-user this connector is kept for, in your own naming (for example your user id). Omit, or leave empty, for your own account's connectors. Only an API key or an OAuth token can read or create an end-user's connector.

labelstring

The label of the connector the sign-in stores into. Needed when the site already holds several connectors for the profile; without it the site's only one is refreshed.

endUserLinkboolean

Also answer endUserUrl: a link for the end-user of profile to sign in on, with no Reduck account. Anyone holding it drives this one sign-in browser until it ends.

Response

OK

loginIdstring required

The sign-in's id. Nothing has to be called with it: it identifies this one in a log.

signInUrlstring required

Where the person signs in: a Reduck page showing the live browser. Give it to the account's owner — the page opens for them and for nobody else, so a link that leaks is a dead end rather than somebody else's browser.

loginUrlstring required

Where the browser was sent, echoed back.

hostsstring[] required

The sites that become connectors, canonical — the login URL's own when none were named.

expiresAtstring required

When the browser closes on its own, storing whatever the jar holds by then.

profilestring

The end-user profile the connectors are stored into; absent for your own account.

endUserUrlstring

With endUserLink: the page the end-user signs in on, no Reduck account needed. It opens this one sign-in only, and stops working when the sign-in ends.

Changes

No recorded changes to this operation across all 1 revision of this API.