WSO2 · JSON Structure

Admin Api Application Structure

Application schema from WSO2 API Manager

Type: object Properties: 11
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Application object with all the application details is a JSON Structure definition published by WSO2, describing 11 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

applicationId name throttlingPolicy description tokenType status groups subscriptionCount attributes subscriptionScopes owner

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-application-structure.json",
  "name": "Application object with all the application details",
  "description": "Application schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "example": "CalculatorApp"
    },
    "throttlingPolicy": {
      "type": "string",
      "example": "Unlimited"
    },
    "description": {
      "type": "string",
      "example": "Sample calculator application"
    },
    "tokenType": {
      "type": "string",
      "enum": [
        "OAUTH",
        "JWT"
      ],
      "description": "Type of the access token generated for this application.\n**OAUTH:** A UUID based access token which is issued by default.\n**JWT:** A self-contained, signed JWT based access token. **Note:** This can be only used in Microgateway environments.\n",
      "default": "JWT",
      "example": "JWT"
    },
    "status": {
      "type": "string",
      "example": "APPROVED",
      "default": ""
    },
    "groups": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": ""
    },
    "subscriptionCount": {
      "type": "int32"
    },
    "attributes": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "example": "External Reference ID, Billing Tier"
    },
    "subscriptionScopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ScopeInfo"
      }
    },
    "owner": {
      "description": "Application created user\n",
      "type": "string",
      "example": "admin"
    }
  }
}