WSO2 · JSON Structure

Admin Api Conditional Group Structure

ConditionalGroup schema from WSO2 API Manager

Type: object Properties: 3 Required: 2
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Conditional Groups for Throttling is a JSON Structure definition published by WSO2, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

description conditions limit

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/admin-api-conditional-group-structure.json",
  "name": "Conditional Groups for Throttling",
  "description": "ConditionalGroup schema from WSO2 API Manager",
  "required": [
    "conditions",
    "limit"
  ],
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Description of the Conditional Group"
    },
    "conditions": {
      "type": "array",
      "description": "Individual throttling conditions. They can be defined as either HeaderCondition, IPCondition, JWTClaimsCondition, QueryParameterCondition\nPlease see schemas of each of those throttling condition in Definitions section.\n",
      "example": "[\n  {\n    \"type\": \"HEADERCONDITION\",\n    \"invertCondition\": false,\n    \"headerCondition\":\n    {\n      \"headerName\": \"Host\",\n      \"headerValue\": \"10.100.7.77\"\n    }\n  },\n  {\n    \"type\": \"IPCONDITION\",\n    \"invertCondition\": false,\n    \"ipCondition\":\n    {\n      \"ipConditionType\": \"IPSPECIFIC\",\n      \"specificIP\": \"10.100.1.22\",\n      \"startingIP\": null,\n      \"endingIP\": null\n    }\n  },\n  {\n    \"type\": \"QUERYPARAMETERCONDITION\",\n    \"invertCondition\": false,\n    \"queryParameterCondition\":\n    {\n      \"parameterName\": \"name\",\n      \"parameterValue\": \"admin\"\n    }\n  },\n  {\n    \"type\": \"JWTCLAIMSCONDITION\",\n    \"invertCondition\": true,\n    \"jwtClaimsCondition\":\n    {\n      \"claimUrl\": \"claimUrl0\",\n      \"attribute\": \"claimAttr0\"\n    }\n  }\n]\n",
      "items": {
        "$ref": "#/components/schemas/ThrottleCondition"
      }
    },
    "limit": {
      "$ref": "#/components/schemas/ThrottleLimit"
    }
  }
}