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
List providers
Authorizations
Response
The type of authentication required by the provider.
oauth2, apiKey, basic, jwt, none The base URL for making API requests.
Additional provider-specific metadata.
The supported features for the provider.
Configuration for API key. Must be provided if authType is apiKey.
How the API key should be attached to requests.
query, header URL with more information about how to get or use an 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.
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 How to transform the API key in to a basic auth user:pass string. The %s is replaced with the API key value.
URL with more information about how to get or use an API key.
The display name of the provider, if omitted, defaults to provider name.
Configuration for OAuth2.0. Must be provided if authType is oauth2.
Whether scopes are required to be known ahead of the OAuth flow.
Whether the workspace is required to be known ahead of the OAuth flow.
authorizationCode, authorizationCodePKCE, clientCredentials, password The token URL.
A list of URLs that represent the audience for the token, which is needed for some client credential grant flows.
The authorization URL.
URL with more information about where to retrieve Client ID and Client Secret, etc.
If true, we require additional information after auth to start making requests.
Was this page helpful?