Provider App
Create a new provider app
Authentication
WRITE API
- Write
READ API
- Read
PLATFORM API
- OAuth
- Project
- Provider App
- Integration
- Revision
- Installation
- Objects & Fields
- Operation
- Provider
- API Key
- Connection
- Group
- Consumer
- Destination
- Upload URL
- Org
- User
- Billing Account
Provider App
Create a new provider app
POST
/
projects
/
{projectIdOrName}
/
provider-apps
curl --request POST \
--url https://api.withampersand.com/v1/projects/{projectIdOrName}/provider-apps \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"externalRef": "external-id-123",
"provider": "salesforce",
"clientId": "client-id-123",
"clientSecret": "client-secret-123",
"scopes": [
[
"read",
"write"
]
]
}'
{
"id": "provider-app-123",
"projectId": "project-456",
"externalRef": "external-id-123",
"provider": "salesforce",
"clientId": "client-id-123",
"scopes": [
[
"oauth",
"offline",
"crm.read"
]
],
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z"
}
Authorizations
Path Parameters
The Ampersand project ID or project name.
Body
application/json
Response
200
application/json
The newly created provider app
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.withampersand.com/v1/projects/{projectIdOrName}/provider-apps \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"externalRef": "external-id-123",
"provider": "salesforce",
"clientId": "client-id-123",
"clientSecret": "client-secret-123",
"scopes": [
[
"read",
"write"
]
]
}'
{
"id": "provider-app-123",
"projectId": "project-456",
"externalRef": "external-id-123",
"provider": "salesforce",
"clientId": "client-id-123",
"scopes": [
[
"oauth",
"offline",
"crm.read"
]
],
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z"
}