WSO2 · JSON Structure

Admin Api Key Manager Configuration Structure

KeyManagerConfiguration schema from WSO2 API Manager

Type: object Properties: 10
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Key Manager Configuration is a JSON Structure definition published by WSO2, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name label type required mask multiple tooltip default values updateDisabled

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-key-manager-configuration-structure.json",
  "name": "Key Manager Configuration",
  "description": "KeyManagerConfiguration schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "consumer_key"
    },
    "label": {
      "type": "string",
      "example": "Consumer Key"
    },
    "type": {
      "type": "string",
      "example": "select"
    },
    "required": {
      "type": "boolean",
      "example": true
    },
    "mask": {
      "type": "boolean",
      "example": true
    },
    "multiple": {
      "type": "boolean",
      "example": true
    },
    "tooltip": {
      "type": "string",
      "example": "Enter username to connect to key manager"
    },
    "default": {
      "type": "object",
      "properties": {},
      "example": "admin"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {}
      }
    },
    "updateDisabled": {
      "type": "boolean",
      "description": "Indicates that this configuration field cannot be modified once the Key Manager is created.",
      "default": false,
      "example": true
    }
  }
}