WSO2 · JSON Structure

Devportal Api Scope Info Structure

ScopeInfo schema from WSO2 API Manager

Type: object Properties: 4
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

API Scope info object with scope details is a JSON Structure definition published by WSO2, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

key name roles description

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/devportal-api-scope-info-structure.json",
  "name": "API Scope info object with scope details",
  "description": "ScopeInfo schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "example": "admin_scope"
    },
    "name": {
      "type": "string",
      "example": "admin scope"
    },
    "roles": {
      "type": "array",
      "description": "Allowed roles for the scope",
      "example": [
        "manager",
        "developer"
      ],
      "items": {
        "type": "string"
      }
    },
    "description": {
      "type": "string",
      "description": "Description of the scope"
    }
  }
}