> ## Documentation Index
> Fetch the complete documentation index at: https://developers.askparable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure a Provider connection

> Replaces the saved credentials, ingestion settings, or parent data filters of a Provider connection in this Workspace. A field you leave out keeps its saved value. A null ingestionConfig or parentDataFilters clears it. authenticationConfig needs the authenticationStrategyId it belongs to. Send the body encrypted with the Workspace encryption key. Requires permission to manage Provider connection secrets.

> [!NOTE]
>
> Send this request body encrypted with your Workspace's encryption key. Parable refuses a plain JSON body with `400`. See [Encrypted request bodies](/getting-started/encryption.md).

## Access

This operation needs a Parable token. An MCP token cannot call it. See [Authentication](/getting-started/authentication.md) for the kinds of token.

Your roles must grant `tenant.connectors.secrets`.

## Errors

* `WA-CN-001`: The Provider connection was not found. Check the connection identifier.
* `WA-CN-002`: The authentication strategy does not belong to this Provider, or authenticationConfig came without authenticationStrategyId. Send one of the Provider's authentication strategies with its configuration.


## OpenAPI

````yaml /api-reference/openapi.json post /api/connectors/configure
openapi: 3.0.3
info:
  description: >-
    Use the Workspace API to work with artifacts, connectors, Parables, and
    account resources.
  title: Workspace API
  version: v2026.10.22.1
servers: []
security: []
paths:
  /api/connectors/configure:
    post:
      tags:
        - Connectors
      summary: Configure a Provider connection
      description: >-
        Replaces the saved credentials, ingestion settings, or parent data
        filters of a Provider connection in this Workspace. A field you leave
        out keeps its saved value. A null ingestionConfig or parentDataFilters
        clears it. authenticationConfig needs the authenticationStrategyId it
        belongs to. Send the body encrypted with the Workspace encryption key.
        Requires permission to manage Provider connection secrets.
      operationId: ConnectorsConfigureConnectorHandler
      parameters:
        - description: >-
            Workspace slug. Overrides subdomain-based workspace resolution when
            provided.
          in: header
          name: X-Tenant
          required: false
          schema:
            example: acme
            type: string
        - description: Optional request correlation ID echoed back in the response.
          in: header
          name: X-Request-ID
          required: false
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureConnectorInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ConfigureConnectorResult'
                  links:
                    $ref: '#/components/schemas/ResponseLinks'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - data
                  - meta
                type: object
          description: Successful response
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            The request is not valid. `detail` says why. A value that breaks a
            field rule gives the code `WA-VL-001` and an `errors` member that
            names each field. The body must be an encrypted envelope that the
            Workspace's encryption key opens. A plain JSON body fails.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: The token is missing, malformed, revoked, or expired.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            The token cannot make this request. For example, the roles of its
            owner do not allow the operation.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: The request failed on the server.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
      security:
        - bearerAuth: []
      x-codeSamples:
        - label: TypeScript SDK
          lang: typescript
          source: >-
            import { WebApiSDK } from "@parable-platform/web-api-sdk";

            import type { ConfigureConnectorInput } from
            "@parable-platform/web-api-types";


            const sdk = new WebApiSDK({
              baseUrl: process.env.PARABLE_API_URL!,
              auth: { token: process.env.PARABLE_API_TOKEN! },
              requestInterceptor: (config) => ({
                ...config,
                headers: { ...config.headers, "X-Tenant": process.env.PARABLE_WORKSPACE! },
              }),
            });

            sdk.setPublicEncryptionKey(await sdk.security.encryptionKey());


            const input: ConfigureConnectorInput = JSON.parse(`{
              "tenantConnectorId": "550e8400-e29b-41d4-a716-446655440000"
            }`);

            const result = await sdk.connectors.configureConnector(
              input
            );
        - label: Python SDK
          lang: python
          source: >-
            import json

            import os


            from parable_types_web_api import ConfigureConnectorInput

            from parable_web_api_sdk import ClientConfig, PublicEncryptionKey,
            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"]},
                )
            )

            key = sdk.security.encryption_key()

            sdk.set_public_encryption_key(
                PublicEncryptionKey(public_key=key.public_key, algorithm=key.algorithm, key_id=key.key_id)
            )


            input_data = ConfigureConnectorInput.model_validate(
                json.loads("{\"tenantConnectorId\":\"550e8400-e29b-41d4-a716-446655440000\"}"),
            )

            result = sdk.connectors.configure_connector(input_data)
        - label: Rust SDK
          lang: rust
          source: >-
            use parable_web_api_sdk::{types, ClientConfig,
            EncryptedRequestOptions, PublicEncryptionKey, RequestOptions,
            WebApiSdk};


            let sdk = WebApiSdk::new(ClientConfig::with_base_url(
                std::env::var("PARABLE_API_URL")?,
                Some(std::env::var("PARABLE_API_TOKEN")?),
                None,
            ))?;

            let options = RequestOptions::with_header("X-Tenant",
            std::env::var("PARABLE_WORKSPACE")?, None, None);

            let key = sdk.security.encryption_key(Some(&options)).await?;

            let encrypted = EncryptedRequestOptions {
                public_encryption_key: Some(PublicEncryptionKey {
                    public_key: key.public_key,
                    algorithm: key.algorithm.to_string(),
                    key_id: key.key_id,
                }),
                request_options: Some(options.clone()),
            };


            let input: types::ConfigureConnectorInput = serde_json::from_value(
                serde_json::json!({
              "tenantConnectorId": "550e8400-e29b-41d4-a716-446655440000"
            }),

            )?;

            let result = sdk.connectors.configure_connector(
                input,
                Some(&encrypted)
            ).await?;
        - label: Go SDK
          lang: go
          source: "sdk, err := webapisdk.New(webapisdk.SDKConfig{\n\tBaseURL: os.Getenv(\"PARABLE_API_URL\"),\n\tAuth:    &webapisdk.AuthConfig{Token: os.Getenv(\"PARABLE_API_TOKEN\")},\n\tRequestInterceptor: func(ctx context.Context, req *http.Request) error {\n\t\treq.Header.Set(\"X-Tenant\", os.Getenv(\"PARABLE_WORKSPACE\"))\n\t\treturn nil\n\t},\n})\nif err != nil {\n\treturn err\n}\nkey, err := sdk.SecurityNamespace.EncryptionKey(ctx)\nif err != nil {\n\treturn err\n}\nsdk.SetPublicEncryptionKey(&webapisdk.PublicEncryptionKey{\n\tPublicKey: string(key.PublicKey),\n\tAlgorithm: string(key.Algorithm),\n\tKeyID:     key.KeyId,\n})\n\nvar input webapitypes.ConfigureConnectorInput\nif err := json.Unmarshal([]byte(`{\"tenantConnectorId\":\"550e8400-e29b-41d4-a716-446655440000\"}`), &input); err != nil {\n\treturn err\n}\nresult, err := sdk.ConnectorsNamespace.ConfigureConnector(ctx, input, nil)"
components:
  schemas:
    ConfigureConnectorInput:
      properties:
        authenticationConfig:
          description: A Parable Schema in JSON
          nullable: true
          type: object
        authenticationStrategyId:
          description: UUID v4 with automatic base62 encoding for client-facing APIs
          nullable: true
          pattern: >-
            ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          type: string
        ingestionConfig:
          description: A Parable Schema in JSON
          nullable: true
          type: object
        parentDataFilters:
          description: 'Workspace allowlist: one predicate per parent tap.'
          items:
            $ref: '#/components/schemas/TenantParentDataFilterEntryInput'
          nullable: true
          type: array
        tenantConnectorId:
          description: UUID v4 with automatic base62 encoding for client-facing APIs
          pattern: >-
            ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          type: string
      required:
        - tenantConnectorId
      type: object
    ConfigureConnectorResult:
      description: Result of configuring a connector
      properties:
        credentialMetadataId:
          description: UUID v4 with automatic base62 encoding for client-facing APIs
          pattern: >-
            ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          type: string
        message:
          type: string
        success:
          type: boolean
      required:
        - success
        - credentialMetadataId
        - message
      type: object
    ResponseLinks:
      properties:
        first:
          nullable: true
          type: string
        last:
          nullable: true
          type: string
        next:
          nullable: true
          type: string
        prev:
          nullable: true
          type: string
      type: object
    ResponseMeta:
      properties:
        requestId:
          description: Unique identifier for the request
          type: string
        totalCount:
          description: Total count of items for paginated responses
          nullable: true
          type: integer
      required:
        - requestId
      type: object
    ProblemDetails:
      description: An error response in the Problem Details format (RFC 9457).
      properties:
        code:
          description: The stable error code, when the problem has one.
          example: WA-VL-001
          type: string
        detail:
          description: What went wrong with this request.
          type: string
        details:
          description: >-
            Structured facts about the refusal, such as the entity or the path
            it concerns. Only some refusals have it.
        errors:
          description: >-
            The fields or filters that failed validation. Only a validation or
            filter error has it.
        requestId:
          description: >-
            The ID of the request, when the problem has one. The `X-Request-ID`
            response header always has it.
          type: string
        status:
          description: The HTTP status code.
          example: 400
          type: integer
        title:
          description: A short summary, usually the text of the HTTP status.
          example: Bad Request
          type: string
        type:
          description: >-
            The problem type. It is `about:blank`: the status and `code`
            identify the problem.
          example: about:blank
          type: string
      required:
        - type
        - title
        - status
        - detail
      type: object
    TenantParentDataFilterEntryInput:
      description: Write-side pair of TenantParentDataFilterEntry.
      properties:
        parentTap:
          maxLength: 255
          type: string
        predicate:
          $ref: '#/components/schemas/ParentEligibilityPredicateInput'
      required:
        - parentTap
        - predicate
      type: object
    ParentEligibilityPredicateInput:
      description: >-
        One condition a parent record must satisfy to be fanned out to a child
        tap.


        A predicate must only encode deterministic expected absence -- a parent
        the

        vendor is already known to have no child rows for. It must never encode

        transient errors, access failures, or merely slow parents; those are

        retryable and filtering them silently loses data.


        ParentEligibilityOperatorEnum documents each operator and its operand.
      properties:
        field:
          description: Parent record field to evaluate. Dotted path for nested fields.
          maxLength: 255
          type: string
        operator:
          $ref: '#/components/schemas/ParentEligibilityOperatorEnum'
          description: Comparison to apply to the field value.
        threshold:
          description: >-
            Operand for the numeric and length operators. Unused by every other
            operator.
          format: double
          nullable: true
          type: number
        values:
          description: Operand for `any_of` and `none_of`. Unused by every other operator.
          items:
            maxLength: 255
            type: string
          maxItems: 10000
          minItems: 1
          nullable: true
          type: array
      required:
        - field
        - operator
      type: object
    ParentEligibilityOperatorEnum:
      description: >-
        Comparison a ParentEligibilityPredicate applies to a parent record
        field.

        A predicate must only encode deterministic expected absence; see the

        predicate schema for that rule.
      enum:
        - any_of
        - none_of
        - exists
        - not_exists
        - gt
        - gte
        - lt
        - lte
        - length_gt
        - length_gte
      type: string
  headers:
    X-Request-ID:
      description: >-
        The ID of the request. It is the `X-Request-ID` value that you sent, or
        an ID that the server made. Give it when you report a problem.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      description: >-
        A personal access token, which starts with `pat_`. A Parable token can
        call each operation that the roles of its owner allow. An MCP token can
        call only the read operations that are open to agents. A SQL token does
        not work on this API.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.