Kong · Schema

Workspace

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
comment	string	A description or additional information about the workspace.
config	object
created_at	integer	Unix epoch when the resource was created.
id	string	A string representing a UUID (universally unique identifier).
meta	object
name	string	A unique string representing a UTF-8 encoded name.
updated_at	integer	Unix epoch when the resource was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Workspace",
  "title": "Workspace",
  "x-speakeasy-entity": "Workspace",
  "type": "object",
  "properties": {
    "comment": {
      "description": "A description or additional information about the workspace.",
      "type": "string",
      "nullable": true
    },
    "config": {
      "type": "object",
      "nullable": true,
      "properties": {
        "meta": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "portal": {
          "type": "boolean",
          "default": false
        },
        "portal_access_request_email": {
          "type": "boolean"
        },
        "portal_application_request_email": {
          "type": "boolean"
        },
        "portal_application_status_email": {
          "type": "boolean"
        },
        "portal_approved_email": {
          "type": "boolean"
        },
        "portal_auth": {
          "type": "string"
        },
        "portal_auth_conf": {
          "type": "string"
        },
        "portal_auto_approve": {
          "type": "boolean"
        },
        "portal_cors_origins": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "portal_developer_meta_fields": {
          "type": "string",
          "default": "[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]"
        },
        "portal_emails_from": {
          "type": "string"
        },
        "portal_emails_reply_to": {
          "type": "string"
        },
        "portal_invite_email": {
          "type": "boolean"
        },
        "portal_is_legacy": {
          "type": "boolean"
        },
        "portal_reset_email": {
          "type": "boolean"
        },
        "portal_reset_success_email": {
          "type": "boolean"
        },
        "portal_session_conf": {
          "type": "string"
        },
        "portal_smtp_admin_emails": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "portal_token_exp": {
          "type": "integer"
        }
      }
    },
    "created_at": {
      "description": "Unix epoch when the resource was created.",
      "type": "integer",
      "nullable": true
    },
    "id": {
      "description": "A string representing a UUID (universally unique identifier).",
      "type": "string",
      "nullable": true
    },
    "meta": {
      "type": "object",
      "nullable": true,
      "properties": {
        "color": {
          "type": "string"
        },
        "thumbnail": {
          "type": "string"
        }
      }
    },
    "name": {
      "description": "A unique string representing a UTF-8 encoded name.",
      "type": "string",
      "minLength": 1
    },
    "updated_at": {
      "description": "Unix epoch when the resource was last updated.",
      "type": "integer",
      "nullable": true
    }
  },
  "example": {
    "comment": "Example workspace comment",
    "config": {
      "meta": {},
      "portal": false,
      "portal_access_request_email": true,
      "portal_application_request_email": true,
      "portal_application_status_email": true,
      "portal_approved_email": true,
      "portal_auth": "basic",
      "portal_auth_conf": "some-auth-config",
      "portal_auto_approve": true,
      "portal_cors_origins": [
        "https://example.com",
        "https://another-origin.com"
      ],
      "portal_developer_meta_fields": "[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",
      "portal_emails_from": "[email protected]",
      "portal_emails_reply_to": "[email protected]",
      "portal_invite_email": true,
      "portal_is_legacy": false,
      "portal_reset_email": true,
      "portal_reset_success_email": true,
      "portal_session_conf": "some-session-config",
      "portal_smtp_admin_emails": [
        "[email protected]",
        "[email protected]"
      ],
      "portal_token_exp": 3600
    },
    "created_at": 1706598432,
    "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
    "meta": {
      "color": "#ffcc00",
      "thumbnail": "https://example.com/image.png"
    },
    "name": "example-workspace"
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}