Kong · Schema

ListRolesResponse

The set of roles available to associate with resources and assign to teams.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
services object
View JSON Schema on GitHub

JSON Schema

kong-listrolesresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListRolesResponse",
  "title": "ListRolesResponse",
  "description": "The set of roles available to associate with resources and assign to teams.",
  "type": "object",
  "properties": {
    "services": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "enum": [
            "Services"
          ]
        },
        "roles": {
          "type": "object",
          "properties": {
            "apiviewer": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "enum": [
                    "API Viewer"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "API Viewers have read-only access to the documentation of a service in a portal"
                  ]
                }
              },
              "required": [
                "name",
                "description"
              ]
            },
            "apiconsumer": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "enum": [
                    "API Consumer"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "API Consumers can make calls to the given service"
                  ]
                }
              },
              "required": [
                "name",
                "description"
              ]
            }
          },
          "required": [
            "apiviewer",
            "apiconsumer"
          ]
        }
      },
      "required": [
        "name",
        "roles"
      ]
    }
  },
  "example": {
    "services": {
      "name": "Services",
      "roles": {
        "apiviewer": {
          "name": "API Viewer",
          "description": "API Viewers have read-only access to the documentation of a service in a portal"
        },
        "apiconsumer": {
          "name": "API Consumer",
          "description": "API Consumers can make calls to the given service"
        }
      }
    }
  },
  "required": [
    "services"
  ]
}