WSO2 · Schema

Key Manager Info

KeyManagerInfo schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
id	string
name	string
type	string
displayName	string	display name of Keymanager
description	string
enabled	boolean
availableGrantTypes	array
tokenEndpoint	string
revokeEndpoint	string
userInfoEndpoint	string
enableTokenGeneration	boolean
enableTokenEncryption	boolean
enableTokenHashing	boolean
enableOAuthAppCreation	boolean
enableMapOAuthConsumerApps	boolean
applicationConfiguration	array
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
additionalProperties	object
tokenType	string	The type of the tokens to be used (exchanged or without exchanged). Accepted values are EXCHANGED, DIRECT and BOTH.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/devportal-api-key-manager-info-schema.json",
  "title": "Key Manager Info",
  "description": "KeyManagerInfo schema from WSO2 API Manager",
  "required": [
    "name",
    "type"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "example": "Resident Key Manager"
    },
    "type": {
      "type": "string",
      "example": "default"
    },
    "displayName": {
      "type": "string",
      "description": "display name of Keymanager\n",
      "example": "Resident Key Manager"
    },
    "description": {
      "type": "string",
      "example": "This is Resident Key Manager"
    },
    "enabled": {
      "type": "boolean",
      "example": true
    },
    "availableGrantTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "client_credentials"
      }
    },
    "tokenEndpoint": {
      "type": "string",
      "example": "https://localhost:9443/oauth2/token"
    },
    "revokeEndpoint": {
      "type": "string",
      "example": "https://localhost:9443/oauth2/revoke"
    },
    "userInfoEndpoint": {
      "type": "string",
      "example": ""
    },
    "enableTokenGeneration": {
      "type": "boolean",
      "example": true
    },
    "enableTokenEncryption": {
      "type": "boolean",
      "example": false,
      "default": false
    },
    "enableTokenHashing": {
      "type": "boolean",
      "example": false,
      "default": false
    },
    "enableOAuthAppCreation": {
      "type": "boolean",
      "example": true,
      "default": true
    },
    "enableMapOAuthConsumerApps": {
      "type": "boolean",
      "example": false,
      "default": false
    },
    "applicationConfiguration": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/KeyManagerApplicationConfiguration"
      }
    },
    "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"
    },
    "additionalProperties": {
      "type": "object",
      "properties": {}
    },
    "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"
      ]
    }
  }
}