API ReferenceConnections

Connect

Creates a Polytomic Connect session and returns a URL for creating or reconnecting a Connection. Open the returned URL, or send it to the person who will set up the Connection. Polytomic Connect guides them through authentication and configuration, then redirects them to `redirect_url`. Each session can create or reconnect one Connection. See also: - [Embedding authentication](../../../guides/embedding-authentication), a guide to using Polytomic Connect.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
namestringRequired
Name of the new connection. Must be unique per organization.
redirect_urlstringRequired
URL to redirect to after connection is created.
connectionstringOptionalformat: "uuid"
The id of an existing connection to update.
darkbooleanOptional
Whether to use the dark theme for the Connect modal.
organization_idstring or nullOptionalformat: "uuid"
ttlinteger or nullOptional
Connect session lifetime in seconds. Defaults to 300 and cannot exceed 604800.
use_organization_namebooleanOptional

Whether to display the target organization name instead of the partner name in the Connect modal. Defaults to false; organizations without a partner always display their organization name.

whitelistlist of strings or nullOptional
List of connection types which are allowed to be created. Ignored if type is set.
typestringOptionalDeprecated
Connection type to create.

Response

OK
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error