Embedded APIResourcesConnections

Create connection

Creates a connection in a customer’s account. This endpoint supports the following in customer accounts:

  • Adding a shell connection
  • Adding and authenticating a connection (not supported for OAuth type connections)

Requires oem_vendor privilege.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
providerstringRequired

The application type of the connection, for example, salesforce.

namestringOptional

Connection name, for example, Prod Salesforce connection.

folder_idintegerOptional
The ID of the project or folder where the connection should be stored.
parent_idintegerOptional
The ID of the parent connection, which must be of the same provider type.
external_idstringOptional
The external ID assigned to the connection, typically given to the user who owns the connection.
shell_connectionbooleanOptional

Specifies whether the connection is a shell connection or an authenticated connection. Defaults to false if not specified. If shell_connection is false, credentials are passed, and the connection is tested and established. If shell_connection is true, credentials are passed, but the connection isn’t tested or established, and additional actions are required for authentication.

inputmap from strings to anyOptional
Connection setting fields.
oauth_token_pairobjectOptional

Response

Success reply
idinteger or null
The unique identifier for the connection.
namestring or null
The name of the connection.
providerstring or null
The provider associated with the connection.
authorized_atstring or null
The timestamp when the connection was authorized.
authorization_statusstring or null
The status of the connection authorization.
authorization_errorstring or null
Details of any authorization errors, if applicable.
created_atstring or null
The timestamp when the connection was created.
updated_atstring or null
The timestamp when the connection was last updated.
external_idstring or null
The external ID associated with the connection, if any.
folder_idinteger or null
The ID of the folder containing the connection.
parent_idinteger or null
The ID of the parent connection, if applicable.

Errors