Create a provider config with authenticated onboarding
Trigger an action to create the provider config after completing an authenticated onboarding flow.
Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Headers
Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.
Path Parameters
Identifier of the resource in Payrails.
Body
Parameters for authenticated provider onboarding. authentication carries the credentials returned by the onboarding flow, depending on the authentication mode.
Account name of the provider.
^[a-zA-Z0-9_-]*$Authentication mode used for provider onboarding.
none, oauth, trackingId Optional ID for the provider configuration. If not specified, a new ID is automatically generated.
Account display name of the provider.
List of workspaces that the provider configuration will be assigned.
Deprecated (use workspaces), Workspace ID that the provider configuration will be assigned.
Custom key-value data included in authorization webhook notifications. Do not store secrets, credentials, or personally identifiable information (PII).
Provider onboarding credentials returned by the authentication flow.
Response
Created.
Unique identifier of the provider config.
Unique identifier of the provider.
Account name of the provider.
^[a-zA-Z0-9_-]*$JSON schema of the provider configuration.
Date of creation of the provider config.
Account display name of the provider.
The status of the provider config.
Workspaces that the Provider config belongs to.
Name of the provider.
Display name of the provider.
Notification URL for this provider config.
Custom key-value data included in authorization webhook notifications. Do not store secrets, credentials, or personally identifiable information (PII).