{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-cloud-setting-schema.json",
  "title": "CloudSetting",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-cloud-settings-api-openapi.yml#/components/schemas/CloudSetting",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "cloud_setting"
      ]
    },
    "api_version": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "2.0.0"
      ]
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "title": {
      "type": "string",
      "maxLength": 1023
    },
    "summary": {
      "type": "string",
      "maxLength": 65535
    },
    "cloud_name": {
      "type": "string"
    },
    "cloud_id": {
      "type": "string"
    },
    "mail_server_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "invitation_ttl": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "reset_password_ttl": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "provision_sandbox_catalog": {
      "type": "boolean"
    },
    "restrict_member_manage_permission": {
      "type": "boolean",
      "default": false
    },
    "access_token_expires_in": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "refresh_token_enabled": {
      "type": "boolean"
    },
    "refresh_expires_in": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "api_key_enabled": {
      "type": "boolean",
      "default": true
    },
    "api_key_expires_in": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "api_key_multiple_uses": {
      "type": "boolean"
    },
    "api_cp_setting": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "apic_runtime_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "apic_runtime_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "endpoint": {
          "$ref": "#/$defs/SecuredEndpoint"
        },
        "ui_endpoint": {
          "$ref": "#/$defs/SecuredEndpoint"
        },
        "iam_endpoint": {
          "type": "string",
          "readOnly": true
        },
        "authenticationType": {
          "type": "string",
          "enum": [
            "basic",
            "apikey",
            "mTLS"
          ]
        },
        "credentials": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "username": {
              "type": [
                "string",
                "null"
              ]
            },
            "password": {
              "type": [
                "string",
                "null"
              ],
              "format": "password"
            },
            "instance_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "api_key": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        },
        "metrics_sync_interval": {
          "type": "integer",
          "minimum": 0,
          "maximum": 86400
        },
        "heartbeat_interval": {
          "type": "integer",
          "minimum": 0,
          "maximum": 86400
        }
      }
    },
    "sso_settings": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "org_types": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "enum": [
              "admin",
              "provider"
            ]
          }
        },
        "default_org_type": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "admin",
            "provider"
          ]
        },
        "user_registry_urls": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "default_user_registry_url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "registration_urls": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "default_registration_url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        }
      }
    },
    "audit_setting": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "audit_reads": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "response_data_to_http_endpoints": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "list_results_limit": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 10000
                }
              }
            }
          }
        },
        "mode": {
          "type": "string",
          "enum": [
            "block",
            "non_block"
          ]
        },
        "endpoints": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "endpoint_type": {
                "type": "string",
                "enum": [
                  "http",
                  "syslog_udp",
                  "syslog_tcp",
                  "syslog_tls"
                ]
              },
              "endpoint": {
                "$ref": "#/$defs/SecuredEndpoint"
              },
              "headers": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": {
                  "type": "string"
                }
              }
            },
            "required": [
              "endpoint"
            ]
          }
        },
        "analytics_service_urls": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "gateway_service_default_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "cloud_manager_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "api_manager_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "platform_api_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "consumer_api_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "platform_api_svc_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "consumer_api_svc_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "license_accepted": {
      "type": "boolean"
    },
    "email_sender": {
      "$ref": "#/$defs/EmailSender"
    },
    "ibm_cloud": {
      "type": "boolean"
    },
    "service_type": {
      "type": "string",
      "enum": [
        "monolithic",
        "microservice"
      ]
    },
    "tls_client_profile_default_url": {
      "type": "string",
      "format": "uri"
    },
    "external_tls_client_profile_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "TLS Client Profile containing CA certificates for external services such as load balancers or WAFs.\n"
    },
    "token_issuer": {
      "type": "string"
    },
    "access_token_keystore_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "id_token_keystore_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "temporary_token_keystore_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "self_signed_token_keystore_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "atm_base_path": {
      "type": [
        "string",
        "null"
      ]
    },
    "temporary_token_format": {
      "type": "string",
      "enum": [
        "jwt",
        "b64"
      ]
    },
    "sync_roles_setting": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "endpoint": {
          "$ref": "#/$defs/SecuredEndpoint"
        }
      }
    },
    "api_security_analytics_service_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "format": "uri"
    }
  },
  "$defs": {
    "EmailSender": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "custom": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    },
    "SecuredEndpoint": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "endpoint"
      ],
      "properties": {
        "endpoint": {
          "type": "string",
          "format": "uri"
        },
        "tls_client_profile_url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        }
      }
    }
  }
}