Python SDK
import json
import os
from parable_types_web_api import StartProviderConnectionSetupInput
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
input_data = StartProviderConnectionSetupInput.model_validate(
json.loads("{\"groupingId\":\"example\",\"idempotencyKey\":\"example\"}"),
)
result = sdk.connectors.start_provider_connection_setup(input_data)sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
var input webapitypes.StartProviderConnectionSetupInput
if err := json.Unmarshal([]byte(`{"groupingId":"example","idempotencyKey":"example"}`), &input); err != nil {
return err
}
result, err := sdk.ConnectorsNamespace.StartProviderConnectionSetup(ctx, input){
"data": {
"expiresAt": "2023-11-07T05:31:56Z",
"groupingId": "<string>",
"groupingPath": "<string>",
"providerName": "<string>",
"setupId": "<string>",
"state": "WAITING_FOR_PERSON",
"url": "<string>",
"vendorSlug": "<string>",
"workspaceSlug": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"connectionStatus": "disabled",
"connectionStatusMessage": "<string>",
"tenantConnectorId": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Start a Provider connection setup
Starts a setup of one Provider connection that the person completes in the Parable app, and returns a link for them. The person signs in, enters the credentials and connects. No credential passes through this call or its result. The link works for 30 minutes and for this person only, and it makes at most one connection. To start again after a setup expired, send a new idempotencyKey.
POST
/
api
/
connectors
/
setups
Python SDK
import json
import os
from parable_types_web_api import StartProviderConnectionSetupInput
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
input_data = StartProviderConnectionSetupInput.model_validate(
json.loads("{\"groupingId\":\"example\",\"idempotencyKey\":\"example\"}"),
)
result = sdk.connectors.start_provider_connection_setup(input_data)sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
var input webapitypes.StartProviderConnectionSetupInput
if err := json.Unmarshal([]byte(`{"groupingId":"example","idempotencyKey":"example"}`), &input); err != nil {
return err
}
result, err := sdk.ConnectorsNamespace.StartProviderConnectionSetup(ctx, input){
"data": {
"expiresAt": "2023-11-07T05:31:56Z",
"groupingId": "<string>",
"groupingPath": "<string>",
"providerName": "<string>",
"setupId": "<string>",
"state": "WAITING_FOR_PERSON",
"url": "<string>",
"vendorSlug": "<string>",
"workspaceSlug": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"connectionStatus": "disabled",
"connectionStatusMessage": "<string>",
"tenantConnectorId": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Access
This operation needs a Parable token. An MCP token cannot call it. See Authentication for the kinds of token. Your roles must granttenant.connectors.create.
Errors
HTTP 403: The person cannot add Provider connections in this Workspace. Ask someone who manages the Workspace’s Providers to connect it.HTTP 404: No way of connecting to a Provider has this groupingId. Read the ways of connecting with list_ways_connecting_provider and use one of their ids.WA-CN-005: The Provider is not released for Workspace enablement. Choose a released Provider.WA-CN-013: This idempotencyKey already started a setup for another way of connecting. Send a new idempotencyKey.
Authorizations
Headers
Body
application/json
Start a setup of one Provider connection that the person completes in the browser.