{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-integration-schema.json",
  "title": "Integration",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-cloud-management-api-openapi.yml#/components/schemas/Integration",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "integration"
      ]
    },
    "api_version": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "2.0.0"
      ]
    },
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "integration_type": {
      "type": "string"
    },
    "title": {
      "type": "string",
      "maxLength": 1023
    },
    "summary": {
      "type": "string",
      "maxLength": 65535
    },
    "state": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "remote": {
      "type": "boolean"
    },
    "integration": {
      "$ref": "#/$defs/IntegrationDocument"
    },
    "tls_client_profile_url": {
      "type": "string",
      "format": "uri"
    },
    "user_registry_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "integration_operation_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "format": "uri"
    }
  },
  "$defs": {
    "InfoSection": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "title",
        "version"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "termsOfService": {
          "type": "string"
        },
        "contact": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string",
              "format": "uri"
            },
            "email": {
              "type": "string",
              "format": "email"
            }
          }
        },
        "license": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "x-ibm-languages": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "IntegrationDocument": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "integration",
        "info"
      ],
      "properties": {
        "integration": {
          "type": "string",
          "enum": [
            "1.0.0"
          ]
        },
        "integration_type": {
          "type": "string",
          "enum": [
            "billing",
            "gateway_service",
            "portal_service",
            "payment_method",
            "notification",
            "user_registry",
            "governance",
            "itopsplatform"
          ]
        },
        "info": {
          "$ref": "#/$defs/InfoSection"
        },
        "properties": {
          "type": "object",
          "additionalProperties": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "boolean"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          }
        },
        "secured_endpoint": {
          "$ref": "#/$defs/SecuredEndpoint"
        },
        "headers": {
          "type": "object",
          "additionalProperties": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "configuration_schema": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "SecuredEndpoint": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "endpoint"
      ],
      "properties": {
        "endpoint": {
          "type": "string",
          "format": "uri"
        },
        "tls_client_profile_url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        }
      }
    }
  }
}