Kong · Schema

AssignedRole

An assigned role is a role that has been assigned to a user or team.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string The ID of the role assignment.
role_name string Name of the role being assigned.
entity_id string A RBAC entity ID.
entity_type_name string Name of the entity type the role is being assigned to.
entity_region string Region of the entity.
View JSON Schema on GitHub

JSON Schema

kong-assignedrole-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AssignedRole",
  "title": "AssignedRole",
  "description": "An assigned role is a role that has been assigned to a user or team.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The ID of the role assignment.",
      "type": "string",
      "format": "uuid",
      "example": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67"
    },
    "role_name": {
      "description": "Name of the role being assigned.",
      "type": "string",
      "example": "Viewer"
    },
    "entity_id": {
      "description": "A RBAC entity ID.",
      "type": "string",
      "format": "uuid",
      "example": "817d0422-45c9-4d88-8d64-45aef05c1ae7"
    },
    "entity_type_name": {
      "description": "Name of the entity type the role is being assigned to.",
      "type": "string",
      "example": "Control Planes"
    },
    "entity_region": {
      "description": "Region of the entity.",
      "type": "string",
      "example": "eu",
      "enum": [
        "us",
        "eu",
        "au",
        "me",
        "in",
        "sg",
        "*"
      ],
      "x-speakeasy-unknown-values": "allow"
    }
  },
  "example": {
    "id": "54cc6168-ebb1-4300-8168-d62a0dd08fc8",
    "role_name": "Viewer",
    "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
    "entity_type_name": "Control Planes",
    "entity_region": "us"
  }
}