POST
/
oauth-connect

Body

application/json
providerWorkspaceRef
string

The identifier for the provider workspace

projectId
string
required

The Ampersand project ID.

groupRef
string
required

The ID that your app uses to identify the group of users for this Connection, this can be an Org ID, workspace ID, etc.

groupName
string

The display name for the group. Defaults to groupRef if not provided.

consumerRef
string
required

The ID that your app uses to identify the user whose SaaS credential will be used for this OAuth flow.

consumerName
string

The display name for the consumer. Defaults to consumerRef if not provided.

providerAppId
string

ID of the provider app (e.g. Salesforce connected app), returned from a CreateProviderApp call. If omitted, the default provider app that was set up on the Ampersand Dashboard is assumed.

provider
string
required

The provider that this app connects to.

Response

200 - text/plain

URL to render

Was this page helpful?

Generate a signed URL to upload write data to.List all projects that the API key or user credential has access to