Apigee · Schema

TlsInfo

TLS configuration for a target server.

Advanced API SecurityAgentic AIAnalyticsAPI GatewayAPI GovernanceAPI HubAPI ManagementDeveloper PortalEnterpriseGenerative AIHybridIntegrationMicroservicesMCPMonetization

Properties

Name	Type	Description
enabled	boolean	Whether TLS is enabled.
clientAuthEnabled	boolean	Whether client authentication is required.
keyStore	string	Name of the keystore.
keyAlias	string	Name of the key alias.
trustStore	string	Name of the truststore.
protocols	array	Supported TLS protocols.
ciphers	array	Supported cipher suites.
commonName	object	Common name configuration.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TlsInfo",
  "title": "TlsInfo",
  "type": "object",
  "description": "TLS configuration for a target server.",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether TLS is enabled."
    },
    "clientAuthEnabled": {
      "type": "boolean",
      "description": "Whether client authentication is required."
    },
    "keyStore": {
      "type": "string",
      "description": "Name of the keystore."
    },
    "keyAlias": {
      "type": "string",
      "description": "Name of the key alias."
    },
    "trustStore": {
      "type": "string",
      "description": "Name of the truststore."
    },
    "protocols": {
      "type": "array",
      "description": "Supported TLS protocols.",
      "items": {
        "type": "string"
      }
    },
    "ciphers": {
      "type": "array",
      "description": "Supported cipher suites.",
      "items": {
        "type": "string"
      }
    },
    "commonName": {
      "type": "object",
      "description": "Common name configuration.",
      "properties": {
        "value": {
          "type": "string"
        },
        "wildcardMatch": {
          "type": "boolean"
        }
      }
    }
  }
}