Create connector

Store a new connector for a website, beside any the site already holds for that profile. Every cookie has to belong to that host. A connector gets its account only from a probe script, so a second connector for the same site and profile needs a label to tell it apart.

post/api/connectors

Request

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

Request body

hoststring required
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

A name for the connector, to tell it apart from the site's other connectors.

Response

Created

idstring required
hoststring required

The website, bare: no scheme, no leading "www.", e.g. "linkedin.com". For an SSO connector this is the identity provider, e.g. "accounts.google.com".

profile_idstring required

The end-user this connector is kept for, as the developer named them. Empty for the account's own connectors.

accountstring nullable required

The identity a probe script or the SSO sign-in reported (usually an email). Null until one has; it is never set by hand.

labelstring nullable required

The name a person gave this connector, to tell it apart from the host's others.

is_ssoboolean required

True when this is an identity-provider session usable for "Continue with <provider>".

sso_accountstring nullable required

For a connector created through an SSO connector: that SSO's account (email). The reference autoreconnect follows. Null otherwise.

created_atstring required
updated_atstring required

Changes

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