Connect

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

Creates a Polytomic Connect session and returns a redirect URL that embeds the Connect modal.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

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

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

Creates a Polytomic Connect session and returns a redirect URL that embeds the Connect modal.

$	curl -X POST https://app.polytomic.com/api/connections/connect \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"name": "Salesforce Connection",
>	"redirect_url": "string"
>	}'

$	curl -X POST https://app.polytomic.com/api/connections/connect \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"name": "Salesforce Connection",
>	"redirect_url": "string"
>	}'

Connect

Authentication

Headers

Request

Response

Errors

Authentication

Headers

Request

Response

Errors

1	{
2	"data": {
3	"redirect_url": "https://app.polytomic.com/connect?type=salesforce&...",
4	"token": "token"
5	}
6	}