Connection
Generate a new connection (only valid for providers with auth types which are not OAuth2 Authorization Code)
Connection
Generate a new connection (only valid for providers with auth types which are not OAuth2 Authorization Code)
POST
/
projects
/
{projectIdOrName}
/
connections:generate
Authorizations
X-Api-Key
string
headerrequiredPath Parameters
projectIdOrName
string
requiredBody
application/json
providerWorkspaceRef
string
The ID of the provider workspace that this connection belongs to.
groupName
string
The name of the user group that has access to this installation.
groupRef
string
requiredThe ID of the user group that has access to this installation.
consumerName
string
The name of the consumer that has access to this installation.
consumerRef
string
requiredThe consumer reference.
provider
string
requiredThe provider name (e.g. "salesforce", "hubspot")
apiKey
string
The API key to use for the connection.
basicAuth
object
oauth2ClientCredentials
object
oauth2Password
object
Response
201 - application/json
id
string
requiredThe connection ID.
projectId
string
requiredThe Ampersand project ID.
providerApp
object
requiredgroup
object
requiredconsumer
object
requiredproviderWorkspaceRef
string
requiredThe identifier for the provider workspace (e.g. "salesforce-instance-domain")
ProviderConsumerRef
string
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)
createTime
string
requiredThe time the connection was created.
updateTime
string
The time the connection was last updated.
Was this page helpful?