Unified.to · Schema

Connection

A connection represents a specific authentication of an integration.

IntegrationsUnified API

Properties

Name Type Description
id string
created_at string
updated_at string
workspace_id string
integration_type string
integration_name string
external_xref string
permissions object
categories object
auth object
is_paused boolean
auth_aws_arn string
environment string
auth_azure_keyvault_id string
auth_gcp_secret_name string
auth_hashi_vault_path string
last_healthy_at string
last_unhealthy_at string
View JSON Schema on GitHub

JSON Schema

unified-to-connection-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-connection-schema.json",
  "title": "Connection",
  "description": "A connection represents a specific authentication of an integration.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "workspace_id": {
      "type": "string"
    },
    "integration_type": {
      "type": "string"
    },
    "integration_name": {
      "type": "string"
    },
    "external_xref": {
      "type": "string"
    },
    "permissions": {
      "$ref": "#/components/schemas/property_Connection_permissions"
    },
    "categories": {
      "$ref": "#/components/schemas/property_Connection_categories"
    },
    "auth": {
      "$ref": "#/components/schemas/property_Connection_auth"
    },
    "is_paused": {
      "type": "boolean"
    },
    "auth_aws_arn": {
      "type": "string"
    },
    "environment": {
      "type": "string",
      "default": "Production"
    },
    "auth_azure_keyvault_id": {
      "type": "string"
    },
    "auth_gcp_secret_name": {
      "type": "string"
    },
    "auth_hashi_vault_path": {
      "type": "string"
    },
    "last_healthy_at": {
      "type": "string",
      "format": "date-time"
    },
    "last_unhealthy_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "integration_type",
    "permissions",
    "categories"
  ]
}