Kong · Schema

PortalAssignRoleRequest

An assigned role associates a service and an action to a team.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name	Type	Description
role_name	string
entity_id	string
entity_type_name	string
entity_region	string	Region of the entity.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PortalAssignRoleRequest",
  "title": "PortalAssignRoleRequest",
  "description": "An assigned role associates a service and an action to a team.",
  "type": "object",
  "properties": {
    "role_name": {
      "type": "string",
      "example": "API Viewer"
    },
    "entity_id": {
      "type": "string",
      "format": "uuid",
      "example": "e67490ce-44dc-4cbd-b65e-b52c746fc26a"
    },
    "entity_type_name": {
      "type": "string",
      "example": "Services"
    },
    "entity_region": {
      "description": "Region of the entity.",
      "type": "string",
      "example": "eu",
      "enum": [
        "us",
        "eu",
        "au",
        "me",
        "in",
        "sg",
        "*"
      ],
      "x-speakeasy-unknown-values": "allow"
    }
  },
  "example": {
    "role_name": "API Viewer",
    "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
    "entity_type_name": "Services",
    "entity_region": "us"
  },
  "required": [
    "role_name",
    "entity_id",
    "entity_type_name",
    "entity_region"
  ]
}