Generate a new connection
For providers which support OAuth2 Authorization Code, it is recommended that you use the /oauth-connect endpoint instead, unless you already have the refresh token and are importing it into Ampersand.
Authorizations
Path Parameters
Body
The consumer reference.
The ID of the user group that has access to this installation.
The provider name (e.g. "salesforce", "hubspot")
The API key to use for the connection.
The name of the consumer that has access to this installation.
The name of the user group that has access to this installation.
The ID of the provider workspace that this connection belongs to.
Response
The authentication scheme used for this connection.
none
, apiKey
, basic
, oauth2/authorizationCode
, oauth2/authorizationCodePKCE
, oauth2/clientCredentials
, oauth2/password
The time the connection was created.
The connection ID.
The Ampersand project ID.
The SaaS provider that this Connection is for.
The status of the connection.
created
, working
, bad_credentials
The API key used while making the connection.
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)
If available, the identifier for the provider workspace (e.g. "salesforce-instance-domain")
The time the connection was last updated.
Was this page helpful?