WSO2 · Schema

APIScope

APIScope schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
scope object
shared boolean States whether scope is shared. This will not be honored when updating/adding scopes to APIs or when adding/updating Shared Scopes.
View JSON Schema on GitHub

JSON Schema

publisher-api-api-scope-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/publisher-api-api-scope-schema.json",
  "title": "APIScope",
  "description": "APIScope schema from WSO2 API Manager",
  "required": [
    "scope"
  ],
  "type": "object",
  "properties": {
    "scope": {
      "$ref": "#/components/schemas/Scope"
    },
    "shared": {
      "type": "boolean",
      "description": "States whether scope is shared. This will not be honored when updating/adding scopes to APIs or when\nadding/updating Shared Scopes.\n",
      "example": true
    }
  }
}