POST
/
projects
/
{projectIdOrName}
/
connections:generate

Authorizations

X-Api-Key
string
header
required

Path Parameters

projectIdOrName
string
required

Body

application/json
consumerRef
string
required

The consumer reference.

groupRef
string
required

The ID of the user group that has access to this installation.

provider
string
required

The provider name (e.g. "salesforce", "hubspot")

apiKey
string

The API key to use for the connection.

basicAuth
object
consumerName
string

The name of the consumer that has access to this installation.

groupName
string

The name of the user group that has access to this installation.

oauth2AuthorizationCode
object
oauth2ClientCredentials
object
oauth2Password
object
providerWorkspaceRef
string

The ID of the provider workspace that this connection belongs to.

Response

201 - application/json
authScheme
enum<string>
required

The authentication scheme used for this connection.

Available options:
none,
apiKey,
basic,
oauth2/authorizationCode,
oauth2/authorizationCodePKCE,
oauth2/clientCredentials,
oauth2/password
consumer
object
required
createTime
string
required

The time the connection was created.

group
object
required
id
string
required

The connection ID.

projectId
string
required

The Ampersand project ID.

provider
string
required

The SaaS provider that this Connection is for.

status
enum<string>
required

The status of the connection.

Available options:
created,
working,
bad_credentials
apiKey
string

The API key used while making the connection.

oauth2AuthorizationCode
object
providerApp
object
providerConsumerRef
string

If available, the ID that Salesforce/Hubspot uses to identify this user (e.g. Salesforce has IDs in the form of https://login.salesforce.com/id/00D4x0000019CQTEA2/0054x000000orJ4AA)

providerWorkspaceRef
string

If available, the identifier for the provider workspace (e.g. "salesforce-instance-domain")

updateTime
string

The time the connection was last updated.