WSO2 · Schema

Key Manager Configuration

KeyManagerConfiguration schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
name string
label string
type string
required boolean
mask boolean
multiple boolean
tooltip string
default object
values array
updateDisabled boolean Indicates that this configuration field cannot be modified once the Key Manager is created.
View JSON Schema on GitHub

JSON Schema

admin-api-key-manager-configuration-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/admin-api-key-manager-configuration-schema.json",
  "title": "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
    }
  }
}