Kong · Schema

Team

The team object contains information about a group of users.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string The team ID.
name string The name of the team.
description string The team description in Konnect.
system_team boolean Returns True if a user belongs to a `system_team`. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"
labels object
created_at string A Unix timestamp representation of team creation.
updated_at string A Unix timestamp representation of the most recent change to the team object in Konnect.
View JSON Schema on GitHub

JSON Schema

kong-team-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Team",
  "title": "Team",
  "x-speakeasy-entity": "Team",
  "description": "The team object contains information about a group of users.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The team ID.",
      "type": "string",
      "format": "uuid",
      "example": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "readOnly": true
    },
    "name": {
      "description": "The name of the team.",
      "type": "string",
      "example": "IDM - Developers",
      "maxLength": 250,
      "pattern": "^[\\w \\W]+$"
    },
    "description": {
      "description": "The team description in Konnect.",
      "type": "string",
      "example": "The developers for the IDM API.",
      "maxLength": 250
    },
    "system_team": {
      "description": "Returns True if a user belongs to a `system_team`. System teams are teams that can manage Konnect objects, like \"Organization Admin\", or \"Service\"",
      "type": "boolean",
      "default": false,
      "readOnly": true
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "created_at": {
      "description": "A Unix timestamp representation of team creation.",
      "type": "string",
      "format": "date-time",
      "example": "1992-02-07T17:46:57.52Z",
      "readOnly": true
    },
    "updated_at": {
      "description": "A Unix timestamp representation of the most recent change to the team object in Konnect.\n",
      "type": "string",
      "format": "date-time",
      "example": "2022-02-07T17:00:00.52Z",
      "readOnly": true
    }
  },
  "example": {
    "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "name": "IDM - Developers",
    "description": "The developers for the IDM API.",
    "system_team": false,
    "labels": {
      "env": "test"
    },
    "created_at": "1992-02-07T17:46:57.52Z",
    "updated_at": "2022-08-31T17:00:00.52Z"
  }
}