API ReferenceConnections

Connect

Creates a Polytomic Connect session and returns a redirect URL that embeds the Connect modal. See also: - [Embedding authentication](https://apidocs.polytomic.com/2024-02-08/guides/embedding-authentication), a guide to using Polytomic Connect.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

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"
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
422
Unprocessable Entity Error
500
Internal Server Error