Sign in
managed-auth

Managed Auth Connect Link Create

post/managed-auth/connect-links

Headers

x-notte-request-originstring nullable
x-notte-sdk-versionstring nullable

Request body

template_idstring required

Connector this link collects credentials for.

labelstring required

Name the resulting connection is created with.

external_user_idstring nullable

Your own identifier for the end user. Echoed back on the completion webhook.

two_fa_method'email' | 'sms' | 'totp' nullable

Second factor this connection will use. Required when the connector supports more than one, because the choice decides whether a mailbox is needed.

mailbox_idstring nullable

Mailbox to read email 2FA codes from. Required when the resolved method is email.

success_redirect_uristring nullable

Where the end user is sent once the account is connected.

error_redirect_uristring nullable

Where the end user is sent when the connection cannot be completed.

webhook_urlstring nullable

Receives the signed completion callback. See the connect-link webhook docs.

ttl_secondsinteger

How long the link stays usable.

scheduleboolean

Whether the resulting connection re-authenticates on a schedule.

Response

Successful Response

connect_link_idstring required
connect_urlstring required

Send your end user here.

tokenstring required

Returned once and never again - only its hash is stored.

expires_atstring date-time required
webhook_signing_secretstring nullable

Workspace secret to verify the completion webhook with. Present only when a webhook_url was supplied. Stable across links, so it is safe to store once.

Changes

Changed in 1 of the 10 revisions of this API.1