WSO2 · Schema

Key Manager

KeyManager schema from WSO2 API Manager

API ManagementGatewaysOpen-SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
id string
name string
displayName string display name of Key Manager to show in UI
type string
description string
wellKnownEndpoint string Well-Known Endpoint of Identity Provider.
introspectionEndpoint string
clientRegistrationEndpoint string
tokenEndpoint string
displayTokenEndpoint string
revokeEndpoint string
displayRevokeEndpoint string
userInfoEndpoint string
authorizeEndpoint string
endpoints array
certificates object
issuer string
alias string The alias of Identity Provider. If the tokenType is EXCHANGED, the alias value should be inclusive in the audience values of the JWT token
scopeManagementEndpoint string
availableGrantTypes array
enableTokenGeneration boolean
enableTokenEncryption boolean
enableTokenHashing boolean
enableMapOAuthConsumerApps boolean
enableOAuthAppCreation boolean
enableSelfValidationJWT boolean
claimMapping array
consumerKeyClaim string
scopesClaim string
tokenValidation array
enabled boolean
global boolean
additionalProperties object
permissions object
tokenType string The type of the tokens to be used (exchanged or without exchanged). Accepted values are EXCHANGED, DIRECT and BOTH.
allowedOrganizations array
View JSON Schema on GitHub

JSON Schema

admin-api-key-manager-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-schema.json",
  "title": "Key Manager",
  "description": "KeyManager schema from WSO2 API Manager",
  "required": [
    "name",
    "type"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string",
      "example": "WSO2 Identity Server"
    },
    "displayName": {
      "maxLength": 100,
      "type": "string",
      "description": "display name of Key Manager to  show in UI\n",
      "example": "WSO2 Identity Server"
    },
    "type": {
      "maxLength": 45,
      "minLength": 1,
      "type": "string",
      "example": "WSO2-IS"
    },
    "description": {
      "maxLength": 256,
      "type": "string",
      "example": "This is a key manager for Developers"
    },
    "wellKnownEndpoint": {
      "type": "string",
      "description": "Well-Known Endpoint of Identity Provider.\n",
      "example": ""
    },
    "introspectionEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/oauth2/introspect",
      "deprecated": true
    },
    "clientRegistrationEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/keymanager-operations/dcr/register",
      "deprecated": true
    },
    "tokenEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/oauth2/token",
      "deprecated": true
    },
    "displayTokenEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/oauth2/token",
      "deprecated": true
    },
    "revokeEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/oauth2/revoke",
      "deprecated": true
    },
    "displayRevokeEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/oauth2/revoke",
      "deprecated": true
    },
    "userInfoEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/oauth2/userinfo?schema=openid",
      "deprecated": true
    },
    "authorizeEndpoint": {
      "type": "string",
      "example": "https://localhost:9444/oauth2/authorize",
      "deprecated": true
    },
    "endpoints": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/KeyManagerEndpoint"
      }
    },
    "certificates": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "JWKS",
            "PEM"
          ]
        },
        "value": {
          "type": "string"
        }
      }
    },
    "issuer": {
      "type": "string",
      "example": "https://localhost:9444/services"
    },
    "alias": {
      "type": "string",
      "description": "The alias of Identity Provider.\nIf the tokenType is EXCHANGED, the alias value should be inclusive in the audience values of the JWT token\n",
      "example": "https://localhost:9443/oauth2/token"
    },
    "scopeManagementEndpoint": {
      "type": "string",
      "example": "https://wso2is.com:9444/api/identity/oauth2/v1.0/scopes",
      "deprecated": true
    },
    "availableGrantTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "client_credentials"
      }
    },
    "enableTokenGeneration": {
      "type": "boolean",
      "example": true
    },
    "enableTokenEncryption": {
      "type": "boolean",
      "example": false,
      "default": false
    },
    "enableTokenHashing": {
      "type": "boolean",
      "example": false,
      "default": false
    },
    "enableMapOAuthConsumerApps": {
      "type": "boolean",
      "example": false,
      "default": false
    },
    "enableOAuthAppCreation": {
      "type": "boolean",
      "example": false,
      "default": false
    },
    "enableSelfValidationJWT": {
      "type": "boolean",
      "example": true,
      "default": true
    },
    "claimMapping": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ClaimMappingEntry"
      }
    },
    "consumerKeyClaim": {
      "type": "string",
      "example": "azp"
    },
    "scopesClaim": {
      "type": "string",
      "example": "scp"
    },
    "tokenValidation": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TokenValidation"
      }
    },
    "enabled": {
      "type": "boolean",
      "example": true
    },
    "global": {
      "type": "boolean",
      "example": true
    },
    "additionalProperties": {
      "type": "object",
      "properties": {},
      "example": {
        "self_validate_jwt": true,
        "Username": "admin",
        "Password": "admin"
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "permissionType": {
          "type": "string",
          "example": "ALLOW",
          "default": "PUBLIC",
          "enum": [
            "PUBLIC",
            "ALLOW",
            "DENY"
          ]
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "Internal/subscriber"
          }
        }
      }
    },
    "tokenType": {
      "type": "string",
      "description": "The type of the tokens to be used (exchanged or without exchanged). Accepted values are EXCHANGED, DIRECT and BOTH.",
      "example": "EXCHANGED",
      "default": "DIRECT",
      "enum": [
        "EXCHANGED",
        "DIRECT",
        "BOTH"
      ]
    },
    "allowedOrganizations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/admin-api-key-manager"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.