Skip to main content
POST

Authorizations

Authorization
string
header
required

a valid bearer token

Path Parameters

projectId
string
required

The unique identifier of the project where the connection will be created

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json

The parameters platformConnectionType, authProvider and authType are inter-dependent. The valid combinations are:

For the exact vault-secret format to send in connectionProperties — the field names and, for secret-backed fields, the {secretName, secretKey} references — for a given platformConnectionType, authProvider and authType, call GET /v1/connections/schema. That endpoint is the source of truth; the examples below are illustrative only.

The connection creation request containing all necessary details

authType
enum<string>
required

The kind of secret being referenced. See the combinations table in the operation description for valid values per connection type.

Available options:
GENERIC_SECRET,
CLOUD_PROVIDER_SECRET,
OAUTH_USER_TOKENS,
OAUTH_AUTHORIZATION_CODE,
OAUTH_CLIENT_CRED,
COMPOSITE_TOKEN,
OAUTH_1_0_X_ADS,
USERNAME_PASSWORD
Example:

"GENERIC_SECRET"

name
string
required

The name of the connection

Minimum string length: 1
Example:

"my-secret"

platformConnectionType
enum<string>
required

The different types of connection that can be created:

  • COMPONENT_BASIC — connect a component to a data source, API, or SaaS application using a secret stored in your secrets manager.
  • CLOUD_PLATFORM_CREDENTIALS — give a project access to a cloud provider (AWS, Azure, Google Cloud) using cloud credentials stored in your secrets manager.
  • COMPONENT — connect a component to a data source, API, or SaaS application whose auth fields vary by authProvider/authType. See GET /v1/connections/schema for the exact fields to send.
Available options:
COMPONENT_BASIC,
CLOUD_PLATFORM_CREDENTIALS,
COMPONENT
Example:

"COMPONENT_BASIC"

authProvider
string

The authentication provider

Example:

"salesforce"

connectionDetails
object

Provides the definition of the values of the connection which will vary by connection type. Includes:

  • Location of any sensitive values (secret location and name)
  • Any non-sensitive values (url, username)

Response

Connection created successfully

authProvider
string

The authentication provider

Example:

"salesforce"

authType
enum<string>

The authentication type

Available options:
GENERIC_SECRET,
CLOUD_PROVIDER_SECRET,
OAUTH_USER_TOKENS,
OAUTH_AUTHORIZATION_CODE,
OAUTH_CLIENT_CRED,
COMPOSITE_TOKEN,
OAUTH_1_0_X_ADS,
USERNAME_PASSWORD
Example:

"GENERIC_SECRET"

connectionDetails
object

Provides the definition of the values of the connection which will vary by connection type. Includes:

  • Location of any sensitive values (secret location and name)
  • Any non-sensitive values (url, username)
createdBy
string

The user who created the connection

createdDate
string<date-time>

The date and time when the connection was created

name
string

The name of the connection

Example:

"my-secret"

platformConnectionType
enum<string>

The different types of connection that can be created:

  • COMPONENT_BASIC — connect a component to a data source, API, or SaaS application using a secret stored in your secrets manager.
  • CLOUD_PLATFORM_CREDENTIALS — give a project access to a cloud provider (AWS, Azure, Google Cloud) using cloud credentials stored in your secrets manager.
  • COMPONENT — connect a component to a data source, API, or SaaS application whose auth fields vary by authProvider/authType.
Available options:
COMPONENT_BASIC,
CLOUD_PLATFORM_CREDENTIALS,
COMPONENT
Example:

"COMPONENT_BASIC"

projectId
string<uuid>

The project ID this connection belongs to