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
Get provider
curl --request GET \
--url https://api.withampersand.com/v1/providers/{provider} \
--header 'X-Api-Key: <api-key>'{
"name": "<string>",
"authType": "oauth2",
"baseURL": "<string>",
"oauth2Opts": {
"grantType": "authorizationCode",
"authURL": "https://login.salesforce.com/services/oauth2/authorize",
"tokenURL": "https://login.salesforce.com/services/oauth2/token",
"explicitScopesRequired": true,
"explicitWorkspaceRequired": true,
"audience": [
"https://api.mparticle.com"
],
"tokenMetadataFields": {
"workspaceRefField": "account-id",
"consumerRefField": "user-id",
"scopesField": "scopes"
},
"docsURL": "https://docs.example.com/client-credentials",
"authURLParams": {
"access_type": "offline",
"duration": "permanent"
}
},
"apiKeyOpts": {
"attachmentType": "query",
"query": {
"name": "api_key"
},
"header": {
"name": "X-Api-Key",
"valuePrefix": "Bearer "
},
"docsURL": "https://docs.example.com/api-key"
},
"basicOpts": {
"apiKeyAsBasic": true,
"apiKeyAsBasicOpts": {
"fieldUsed": "username",
"keyFormat": "api:%s"
},
"docsURL": "https://docs.example.com/api-key"
},
"support": {
"bulkWrite": {
"insert": true,
"update": true,
"upsert": true,
"delete": true
},
"proxy": true,
"read": true,
"subscribe": true,
"write": true,
"subscribeSupport": {
"create": true,
"update": true,
"delete": true,
"passThrough": true
}
},
"providerOpts": {},
"displayName": "Zendesk Chat",
"postAuthInfoNeeded": true,
"media": {
"regular": {
"iconURL": "https://example.com/icon.png",
"logoURL": "https://example.com/logo.png"
},
"darkMode": {
"iconURL": "https://example.com/icon.png",
"logoURL": "https://example.com/logo.png"
}
},
"labels": {},
"subscribeOpts": {
"subscriptionScope": "integration",
"targetURLScope": "integration",
"registrationTiming": "providerApp"
}
}Authorizations
Path Parameters
Response
The type of authentication required by the provider.
oauth2, apiKey, basic, jwt, none The base URL for making API requests.
The supported features for the provider.
Configuration for OAuth2.0. Must be provided if authType is oauth2.
authorizationCode, authorizationCodePKCE, clientCredentials, password The token URL.
"https://login.salesforce.com/services/oauth2/token"
Whether scopes are required to be known ahead of the OAuth flow.
true
Whether the workspace is required to be known ahead of the OAuth flow.
true
The authorization URL.
"https://login.salesforce.com/services/oauth2/authorize"
A list of URLs that represent the audience for the token, which is needed for some client credential grant flows.
["https://api.mparticle.com"]
URL with more information about where to retrieve Client ID and Client Secret, etc.
"https://docs.example.com/client-credentials"
Configuration for API key. Must be provided if authType is apiKey.
How the API key should be attached to requests.
query, header Configuration for API key in query parameter. Must be provided if type is in-query.
The name of the query parameter to be used for the API key.
"api_key"
Configuration for API key in header. Must be provided if type is in-header.
URL with more information about how to get or use an API key.
"https://docs.example.com/api-key"
Configuration for Basic Auth. Optional.
If true, the provider uses an API key which then gets encoded as a basic auth user:pass string.
true
when this object is present, it means that this provider uses Basic Auth to actually collect an API key
whether the API key should be used as the username or password.
username, password "username"
How to transform the API key in to a basic auth user:pass string. The %s is replaced with the API key value.
"api:%s"
URL with more information about how to get or use an API key.
"https://docs.example.com/api-key"
The display name of the provider, if omitted, defaults to provider name.
"Zendesk Chat"
If true, we require additional information after auth to start making requests.
true
The scope of the subscription.
integration, installation The scope of the target URL.
integration, installation The timing of the registration.
providerApp, integration, installation Was this page helpful?
curl --request GET \
--url https://api.withampersand.com/v1/providers/{provider} \
--header 'X-Api-Key: <api-key>'{
"name": "<string>",
"authType": "oauth2",
"baseURL": "<string>",
"oauth2Opts": {
"grantType": "authorizationCode",
"authURL": "https://login.salesforce.com/services/oauth2/authorize",
"tokenURL": "https://login.salesforce.com/services/oauth2/token",
"explicitScopesRequired": true,
"explicitWorkspaceRequired": true,
"audience": [
"https://api.mparticle.com"
],
"tokenMetadataFields": {
"workspaceRefField": "account-id",
"consumerRefField": "user-id",
"scopesField": "scopes"
},
"docsURL": "https://docs.example.com/client-credentials",
"authURLParams": {
"access_type": "offline",
"duration": "permanent"
}
},
"apiKeyOpts": {
"attachmentType": "query",
"query": {
"name": "api_key"
},
"header": {
"name": "X-Api-Key",
"valuePrefix": "Bearer "
},
"docsURL": "https://docs.example.com/api-key"
},
"basicOpts": {
"apiKeyAsBasic": true,
"apiKeyAsBasicOpts": {
"fieldUsed": "username",
"keyFormat": "api:%s"
},
"docsURL": "https://docs.example.com/api-key"
},
"support": {
"bulkWrite": {
"insert": true,
"update": true,
"upsert": true,
"delete": true
},
"proxy": true,
"read": true,
"subscribe": true,
"write": true,
"subscribeSupport": {
"create": true,
"update": true,
"delete": true,
"passThrough": true
}
},
"providerOpts": {},
"displayName": "Zendesk Chat",
"postAuthInfoNeeded": true,
"media": {
"regular": {
"iconURL": "https://example.com/icon.png",
"logoURL": "https://example.com/logo.png"
},
"darkMode": {
"iconURL": "https://example.com/icon.png",
"logoURL": "https://example.com/logo.png"
}
},
"labels": {},
"subscribeOpts": {
"subscriptionScope": "integration",
"targetURLScope": "integration",
"registrationTiming": "providerApp"
}
}