POST
/
oauth-connect
Get URL for OAuth flow
curl --request POST \
  --url https://api.withampersand.com/v1/oauth-connect \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "projectId": "my-project",
  "provider": "salesforce",
  "groupRef": "group-123",
  "groupName": "Organization Name",
  "consumerRef": "user_123456",
  "consumerName": "John Doe",
  "providerWorkspaceRef": "salesforce-instance-domain",
  "providerMetadata": {},
  "providerAppId": "32356abe-d2fd-49c7-9030-abdcbc6456d4",
  "enableCSRFProtection": false
}'
"<string>"

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
projectId
string
required

The Ampersand project ID.

Example:

"my-project"

​
provider
string
required

The provider that this app connects to.

Example:

"salesforce"

​
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.

Example:

"group-123"

​
consumerRef
string
required

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

Example:

"user_123456"

​
groupName
string

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

Example:

"Organization Name"

​
consumerName
string

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

Example:

"John Doe"

​
providerWorkspaceRef
string

The identifier for the provider workspace (e.g. the Salesforce subdomain).

Example:

"salesforce-instance-domain"

​
providerMetadata
object
​
providerAppId
string

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

Example:

"32356abe-d2fd-49c7-9030-abdcbc6456d4"

​
enableCSRFProtection
boolean

This boolean flag is used by the UI library internally. Set it to false or omit it when manually calling this API.

Example:

false

Response

OK

URL to render