Ampersand · JSON Structure

Ampersand Api Update Connection Request Structure

Specify which fields to update in `updateMask` and provide corresponding values in `connection`. Fields in `connection` not listed in `updateMask` are ignored.

Type: object Properties: 2 Required: 2
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

UpdateConnectionRequest is a JSON Structure definition published by Ampersand, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

updateMask connection

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-update-connection-request-structure.json",
  "name": "UpdateConnectionRequest",
  "description": "Specify which fields to update in `updateMask` and provide corresponding values in `connection`. Fields in `connection` not listed in `updateMask` are ignored.",
  "type": "object",
  "properties": {
    "updateMask": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "providerWorkspaceRef",
          "providerMetadata",
          "apiKey",
          "basicAuth",
          "oauth2ClientCredentials",
          "oauth2PasswordCredentials"
        ]
      },
      "description": "Fields to update. Each entry must have a corresponding value in `connection`. Credential fields (`apiKey`, `basicAuth`, `oauth2ClientCredentials`, `oauth2PasswordCredentials`) must match the connection's existing auth scheme.",
      "example": [
        "apiKey"
      ]
    },
    "connection": {
      "$ref": "#/components/schemas/ConnectionRequest"
    }
  },
  "required": [
    "updateMask",
    "connection"
  ]
}