diff --git a/.github/workflows/module-test-pipeline.yml b/.github/workflows/module-test-pipeline.yml index 849f0d0..cd26d8a 100644 --- a/.github/workflows/module-test-pipeline.yml +++ b/.github/workflows/module-test-pipeline.yml @@ -58,7 +58,7 @@ jobs: SWAGGER_SPEC_NAME=`ls ci/swagger_spec` echo "Generating code using spec $SWAGGER_SPEC_NAME" rm ./*.tf - SEMP_V2_SWAGGER_CONFIG_EXTENDED_JSON="ci/swagger_spec/$SWAGGER_SPEC_NAME" MODULE_TEMPLATE_FOLDER="internal/gen-template" ~/go/bin/broker-terraform-code-generator software-module + SEMP_V2_SWAGGER_CONFIG_EXTENDED_JSON="ci/swagger_spec/$SWAGGER_SPEC_NAME" MODULE_TEMPLATE_FOLDER="internal/gen-template" ~/go/bin/broker-terraform-code-generator appliance-module - name: Add copyright headers where needed run: | diff --git a/README.md b/README.md index 25ebc7d..468f7ab 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Solace PubSub+ Software Event Broker Queues & Endpoints Terraform Module +# Solace PubSub+ Appliance Queues & Endpoints Terraform Module Terraform module to configure a "guaranteed messaging endpoint" or an "endpoint template" on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). @@ -28,10 +28,10 @@ Optional module variables are either shared by multiple types, or conditional to | Resource name | |---------------| -|[solacebroker_msg_vpn_queue](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue#optional)| -|[solacebroker_msg_vpn_topic_endpoint](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_topic_endpoint#optional)| -|[solacebroker_msg_vpn_queue_template](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue_template#optional)| -|[solacebroker_msg_vpn_topic_endpoint_template](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_topic_endpoint_template#optional)| +|[solacebroker_msg_vpn_queue](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional)| +|[solacebroker_msg_vpn_topic_endpoint](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional)| +|[solacebroker_msg_vpn_queue_template](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional)| +|[solacebroker_msg_vpn_topic_endpoint_template](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#optional)| Most optional variables' default value is `null`, meaning that if not provided then the resource default value will be provisioned on the broker. @@ -45,7 +45,7 @@ Most optional variables' default value is `null`, meaning that if not provided t | Name | Version | |------|---------| -| [solacebroker](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest) | ~> 0.9 | +| [solacebroker](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest) | ~> 0.9 | ## Resources diff --git a/ci/module-test/main.tf b/ci/module-test/main.tf index bf5e7e8..149b223 100644 --- a/ci/module-test/main.tf +++ b/ci/module-test/main.tf @@ -2,6 +2,7 @@ provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "messaging_endpoint_1" { diff --git a/ci/module-test/providers.tf b/ci/module-test/providers.tf index c96b421..440c98f 100644 --- a/ci/module-test/providers.tf +++ b/ci/module-test/providers.tf @@ -3,7 +3,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/ci/scripts/test-module.sh b/ci/scripts/test-module.sh old mode 100644 new mode 100755 diff --git a/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.vm.json b/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.lm.json similarity index 92% rename from ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.vm.json rename to ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.lm.json index ae21381..9e17bed 100644 --- a/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.vm.json +++ b/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.lm.json @@ -82,7 +82,7 @@ "AboutLinks": { "properties": { "apiUri": { - "description": "The URI of this About's API Description object. Available since 2.2.", + "description": "The URI of this About's API Description object. Available since 2.4.", "type": "string" }, "uri": { @@ -90,7 +90,7 @@ "type": "string" }, "userUri": { - "description": "The URI of this About's User object. Available since 2.2.", + "description": "The URI of this About's User object. Available since 2.4.", "type": "string" } }, @@ -880,6 +880,56 @@ "x-requiresDisable": [], "x-writeOnly": false }, + "guaranteedMsgingDiskArrayWwn": { + "description": "The WWN number to use when accessing a LUN on an external disk array. The default value is `\"\"`. Available since 2.18.", + "maxLength": 64, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-default": "", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "guaranteedMsgingDiskLocation": { + "description": "The disk location for the the guaranteed message spool (required for high availability with guaranteed messaging). When external is chosen the guaranteed message spool is stored on an external disk array attached to the router. If internal storage is currently used, changing to external causes message spooling on the router to stop and messages spooled on the internal storage to be deleted. If internal is chosen the guaranteed message spool is stored on an external disk array attached to the router. If internal storage is currently used, changing to external causes message spooling on the router to stop and messages spooled on the internal storage to be deleted. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as guaranteedMsgingEnabled will be temporarily set to false to apply the change. The default value is `\"external\"`. The allowed values and their meaning are:\n\n
\n\"external\" - The guaranteed message spool is stored on an external disk array attached to the appliance.\n\"internal\" - The guaranteed message spool is stored internally on the appliance.\n
\n Available since 2.18.", + "enum": [ + "external", + "internal" + ], + "type": "string", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [ + "guaranteedMsgingEnabled" + ], + "x-configSyncDefault": "external", + "x-default": "external", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, "guaranteedMsgingEnabled": { "description": "Enable or disable Guaranteed Messaging. The default value is `false`. Available since 2.18.", "type": "boolean", @@ -963,7 +1013,7 @@ "x-writeOnly": false }, "guaranteedMsgingMaxMsgSpoolUsage": { - "description": "The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1500`. Available since 2.18.", + "description": "The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `60000`. Available since 2.18.", "format": "int64", "maximum": 6000000, "minimum": 0, @@ -973,33 +1023,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1500, + "x-configSyncDefault": 60000, "x-configSyncTableType": "router", - "x-default": 1500, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout": { - "description": "The maximum time, in milliseconds, that can be tolerated for remote acknowledgment of synchronization messages before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 10000, - "x-default": 10000, + "x-default": 60000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -1011,19 +1037,21 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout": { - "description": "The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "guaranteedMsgingTransactionReplicationCompatibilityMode": { + "description": "The replication compatibility mode for the broker. The default value is `\"legacy\"`. The allowed values and their meaning are:\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"legacy\"`. The allowed values and their meaning are:\n\n
\n\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\n\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions.\n
\n Available since 2.18.", + "enum": [ + "legacy", + "transacted" + ], + "type": "string", "x-accessLevels": { "get": "global/read-only", "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 10000, - "x-default": 10000, + "x-configSyncDefault": "legacy", + "x-configSyncTableType": "router", + "x-default": "legacy", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -1035,21 +1063,22 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "guaranteedMsgingTransactionReplicationCompatibilityMode": { - "description": "The replication compatibility mode for the broker. The default value is `\"legacy\"`. The allowed values and their meaning are:\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"legacy\"`. The allowed values and their meaning are:\n\n
\n\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\n\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions.\n
\n Available since 2.18.", + "guaranteedMsgingVirtualRouterWhenActiveActive": { + "description": "The High Availability role for this broker if using the legacy Active/Active configuration for high availability (not recommended). Note: for Active/Standby high availability configuration, this setting is ignored. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as guaranteedMsgingEnabled will be temporarily set to false to apply the change. The default value is `\"primary\"`. The allowed values and their meaning are:\n\n
\n\"primary\" - The primary virtual router.\n\"backup\" - The backup virtual router.\n
\n Available since 2.18.", "enum": [ - "legacy", - "transacted" + "primary", + "backup" ], "type": "string", "x-accessLevels": { "get": "global/read-only", "patch": "global/read-write" }, - "x-autoDisable": [], - "x-configSyncDefault": "legacy", - "x-configSyncTableType": "router", - "x-default": "legacy", + "x-autoDisable": [ + "guaranteedMsgingEnabled" + ], + "x-configSyncDefault": "primary", + "x-default": "primary", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -1236,53 +1265,6 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceMateLinkEnabled": { - "description": "Enable or disable the mate-link service. The default value is `true`. Available since 2.17.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceMateLinkListenPort": { - "description": "The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMateLinkEnabled will be temporarily set to false to apply the change. The default value is `8741`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceMateLinkEnabled" - ], - "x-configSyncDefault": 8741, - "x-default": 8741, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, "serviceMqttEnabled": { "description": "Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", "type": "boolean", @@ -1326,53 +1308,6 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceRedundancyEnabled": { - "description": "Enable or disable the redundancy service. The default value is `true`. Available since 2.17.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceRedundancyFirstListenPort": { - "description": "The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceRedundancyEnabled will be temporarily set to false to apply the change. The default value is `8300`. Available since 2.17.", - "format": "int64", - "maximum": 65533, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceRedundancyEnabled" - ], - "x-configSyncDefault": 8300, - "x-default": 8300, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, "serviceRestEventOutgoingConnectionCountThreshold": { "$ref": "#/definitions/ServiceRestEventOutgoingConnectionCountThreshold" }, @@ -1766,7 +1701,7 @@ "x-writeOnly": false }, "serviceWebTransportPlainTextListenPort": { - "description": "The TCP port for plain-text WEB client connections. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceWebTransportEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `8008`. Available since 2.17.", + "description": "The TCP port for plain-text WEB client connections. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceWebTransportEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `80`. Available since 2.17.", "format": "int64", "maximum": 65535, "minimum": 1, @@ -1778,9 +1713,9 @@ "x-autoDisable": [ "serviceWebTransportEnabled" ], - "x-configSyncDefault": 8008, + "x-configSyncDefault": 80, "x-configSyncTableType": "router", - "x-default": 8008, + "x-default": 80, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -1793,7 +1728,7 @@ "x-writeOnly": false }, "serviceWebTransportTlsListenPort": { - "description": "The TCP port for TLS WEB client connections. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceWebTransportEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1443`. Available since 2.17.", + "description": "The TCP port for TLS WEB client connections. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceWebTransportEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `443`. Available since 2.17.", "format": "int64", "maximum": 65535, "minimum": 1, @@ -1805,9 +1740,9 @@ "x-autoDisable": [ "serviceWebTransportEnabled" ], - "x-configSyncDefault": 1443, + "x-configSyncDefault": 443, "x-configSyncTableType": "router", - "x-default": 1443, + "x-default": 443, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -1844,6 +1779,28 @@ "x-requiresDisable": [], "x-writeOnly": false }, + "tlsBlockVersion10Enabled": { + "description": "Enable or disable the blocking of incoming TLS version 1.0 connections. When blocked, existing TLS 1.0 connections from Clients and SEMP users remain connected while new connections are blocked. Note that support for TLS 1.0 will eventually be discontinued, at which time TLS 1.0 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": true, + "x-configSyncTableType": "router", + "x-default": true, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, "tlsBlockVersion11Enabled": { "description": "Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", "type": "boolean", @@ -2180,7 +2137,7 @@ "type": "string" }, "systemInformationUri": { - "description": "The URI of this Broker's System Information object. Deprecated since 2.2. /systemInformation was replaced by /about/api.", + "description": "The URI of this Broker's System Information object. Deprecated since 2.4. /systemInformation was replaced by /about/api.", "type": "string" }, "uri": { @@ -4399,7 +4356,7 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1500, + "x-configSyncDefault": 4000, "x-configSyncTableType": "router", "x-default": 800000, "x-deprecated": false, @@ -6792,7 +6749,7 @@ "x-writeOnly": false }, "authenticationClientCertRevocationCheckMode": { - "description": "The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow-valid\"`. The allowed values and their meaning are:\n\n
\n\"allow-all\" - Allow the client to authenticate, the result of client certificate revocation check is ignored.\n\"allow-unknown\" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined.\n\"allow-valid\" - Allow the client to authenticate only when the revocation check returned an explicit positive response.\n
\n Available since 2.6.", + "description": "The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow-valid\"`. The allowed values and their meaning are:\n\n
\n\"allow-all\" - Allow the client to authenticate, the result of client certificate revocation check is ignored.\n\"allow-unknown\" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined.\n\"allow-valid\" - Allow the client to authenticate only when the revocation check returned an explicit positive response.\n
\n Available since 2.8.", "enum": [ "allow-all", "allow-unknown", @@ -6819,7 +6776,7 @@ "x-writeOnly": false }, "authenticationClientCertUsernameSource": { - "description": "The field from the client certificate to use as the client username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"common-name\"`. The allowed values and their meaning are:\n\n
\n\"certificate-thumbprint\" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.\n\"common-name\" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.\n\"common-name-last\" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.\n\"subject-alternate-name-msupn\" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.\n\"uid\" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.\n\"uid-last\" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.\n
\n Available since 2.6.", + "description": "The field from the client certificate to use as the client username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"common-name\"`. The allowed values and their meaning are:\n\n
\n\"certificate-thumbprint\" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.\n\"common-name\" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.\n\"common-name-last\" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.\n\"subject-alternate-name-msupn\" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.\n\"uid\" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.\n\"uid-last\" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.\n
\n Available since 2.5.", "enum": [ "certificate-thumbprint", "common-name", @@ -7482,7 +7439,7 @@ "x-writeOnly": false }, "jndiEnabled": { - "description": "Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2.", + "description": "Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.4.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -7527,7 +7484,7 @@ "x-writeOnly": false }, "maxEgressFlowCount": { - "description": "The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "description": "The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `16000`.", "format": "int64", "maximum": 200000, "minimum": 0, @@ -7537,9 +7494,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 16000, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-default": 16000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -7552,7 +7509,7 @@ "x-writeOnly": false }, "maxEndpointCount": { - "description": "The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "description": "The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `16000`.", "format": "int64", "maximum": 200000, "minimum": 0, @@ -7562,9 +7519,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 16000, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-default": 16000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -7577,7 +7534,7 @@ "x-writeOnly": false }, "maxIngressFlowCount": { - "description": "The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "description": "The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `16000`.", "format": "int64", "maximum": 1000000, "minimum": 0, @@ -7587,9 +7544,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 16000, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-default": 16000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -7652,7 +7609,7 @@ "maxTransactedSessionCount": { "description": "The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", "format": "int64", - "maximum": 30000, + "maximum": 100000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -7675,7 +7632,7 @@ "maxTransactionCount": { "description": "The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", "format": "int64", - "maximum": 50000, + "maximum": 100000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -7741,6 +7698,32 @@ "x-requiresDisable": [], "x-writeOnly": false }, + "preferIpVersion": { + "description": "IP version to use if DNS lookup contains both an IPv4 and IPv6 address. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"ipv6\"`. The allowed values and their meaning are:\n\n
\n\"ipv4\" - Use IPv4 address when DNS lookup contains both an IPv4 and IPv6 address.\n\"ipv6\" - Use IPv6 address when DNS lookup contains both an IPv4 and IPv6 address.\n
\n Deprecated since 2.24. Where supported, the broker will attempt connections to both IPv4 and IPv6 addresses as appropriate.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": "ipv6", + "x-configSyncTableType": "vpn", + "x-default": "ipv6", + "x-deprecated": true, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, "replicationAckPropagationIntervalMsgCount": { "description": "The acknowledgment (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`.", "format": "int64", @@ -8363,8 +8346,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "sempOverMsgBusShowEnabled": { - "description": "Enable or disable \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "sempOverMsgBusLegacyShowClearEnabled": { + "description": "Enable or disable \"legacy-show-clear\" SEMP over the message bus commands (that is, SEMP show and administration requests published to the topic \"#P2P/[router name]/#client/SEMP\") for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -8385,85 +8368,13 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceAmqpMaxConnectionCount": { - "description": "The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceAmqpPlainTextEnabled": { - "description": "Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.", + "sempOverMsgBusShowEnabled": { + "description": "Enable or disable \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceAmqpPlainTextListenPort": { - "description": "The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpPlainTextEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "global/read-write" }, - "x-autoDisable": [ - "serviceAmqpPlainTextEnabled" - ], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceAmqpTlsEnabled": { - "description": "Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, "x-autoDisable": [], "x-configSyncDefault": false, "x-configSyncTableType": "vpn", @@ -8479,62 +8390,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceAmqpTlsListenPort": { - "description": "The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceAmqpTlsEnabled" - ], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceMqttAuthenticationClientCertRequest": { - "description": "Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn >  authentication > client-certificate > shutdown\".\n
\n Available since 2.21.", - "enum": [ - "always", - "never", - "when-enabled-in-message-vpn" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "when-enabled-in-message-vpn", - "x-configSyncTableType": "vpn", - "x-default": "when-enabled-in-message-vpn", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceMqttMaxConnectionCount": { - "description": "The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1.", + "serviceAmqpMaxConnectionCount": { + "description": "The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.8.", "format": "int64", "maximum": 200000, "minimum": 0, @@ -8556,106 +8413,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceMqttPlainTextEnabled": { - "description": "Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceMqttPlainTextListenPort": { - "description": "The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttPlainTextEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceMqttPlainTextEnabled" - ], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceMqttTlsEnabled": { - "description": "Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceMqttTlsListenPort": { - "description": "The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceMqttTlsEnabled" - ], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "serviceMqttTlsWebSocketEnabled": { - "description": "Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", + "serviceAmqpPlainTextEnabled": { + "description": "Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -8676,8 +8435,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceMqttTlsWebSocketListenPort": { - "description": "The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttTlsWebSocketEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", + "serviceAmqpPlainTextListenPort": { + "description": "The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpPlainTextEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.8.", "format": "int64", "maximum": 65535, "minimum": 0, @@ -8687,7 +8446,7 @@ "patch": "global/read-write" }, "x-autoDisable": [ - "serviceMqttTlsWebSocketEnabled" + "serviceAmqpPlainTextEnabled" ], "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", @@ -8703,8 +8462,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceMqttWebSocketEnabled": { - "description": "Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", + "serviceAmqpTlsEnabled": { + "description": "Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -8725,8 +8484,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceMqttWebSocketListenPort": { - "description": "The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttWebSocketEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", + "serviceAmqpTlsListenPort": { + "description": "The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.8.", "format": "int64", "maximum": 65535, "minimum": 0, @@ -8736,7 +8495,7 @@ "patch": "global/read-write" }, "x-autoDisable": [ - "serviceMqttWebSocketEnabled" + "serviceAmqpTlsEnabled" ], "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", @@ -8752,8 +8511,254 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "serviceRestIncomingAuthenticationClientCertRequest": { - "description": "Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn >  authentication > client-certificate > shutdown\".\n
\n Available since 2.21.", + "serviceMqttAuthenticationClientCertRequest": { + "description": "Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn >  authentication > client-certificate > shutdown\".\n
\n Available since 2.21.", + "enum": [ + "always", + "never", + "when-enabled-in-message-vpn" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": "when-enabled-in-message-vpn", + "x-configSyncTableType": "vpn", + "x-default": "when-enabled-in-message-vpn", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttMaxConnectionCount": { + "description": "The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.4.", + "format": "int64", + "maximum": 200000, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttPlainTextEnabled": { + "description": "Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.4.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttPlainTextListenPort": { + "description": "The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttPlainTextEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.4.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [ + "serviceMqttPlainTextEnabled" + ], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttTlsEnabled": { + "description": "Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.4.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttTlsListenPort": { + "description": "The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttTlsEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.4.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [ + "serviceMqttTlsEnabled" + ], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttTlsWebSocketEnabled": { + "description": "Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.4.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttTlsWebSocketListenPort": { + "description": "The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttTlsWebSocketEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.4.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [ + "serviceMqttTlsWebSocketEnabled" + ], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttWebSocketEnabled": { + "description": "Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.4.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceMqttWebSocketListenPort": { + "description": "The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceMqttWebSocketEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.4.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [ + "serviceMqttWebSocketEnabled" + ], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "serviceRestIncomingAuthenticationClientCertRequest": { + "description": "Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn >  authentication > client-certificate > shutdown\".\n
\n Available since 2.21.", "enum": [ "always", "never", @@ -8928,7 +8933,7 @@ "x-writeOnly": false }, "serviceRestMode": { - "description": "The REST service mode for incoming REST clients that connect to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"messaging\"`. The allowed values and their meaning are:\n\n
\n\"gateway\" - Act as a message gateway through which REST messages are propagated.\n\"messaging\" - Act as a message broker on which REST messages are queued.\n
\n Available since 2.6.", + "description": "The REST service mode for incoming REST clients that connect to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"messaging\"`. The allowed values and their meaning are:\n\n
\n\"gateway\" - Act as a message gateway through which REST messages are propagated.\n\"messaging\" - Act as a message broker on which REST messages are queued.\n
\n Available since 2.8.", "enum": [ "gateway", "messaging" @@ -14182,7 +14187,7 @@ "x-writeOnly": false }, "maxEgressFlowCount": { - "description": "The maximum number of transmit flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "description": "The maximum number of transmit flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `16000`.", "format": "int64", "maximum": 200000, "minimum": 0, @@ -14192,9 +14197,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 16000, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-default": 16000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -14207,7 +14212,7 @@ "x-writeOnly": false }, "maxEndpointCountPerClientUsername": { - "description": "The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "description": "The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `16000`.", "format": "int64", "maximum": 200000, "minimum": 0, @@ -14217,9 +14222,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 16000, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-default": 16000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -14232,7 +14237,7 @@ "x-writeOnly": false }, "maxIngressFlowCount": { - "description": "The maximum number of receive flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "description": "The maximum number of receive flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `16000`.", "format": "int64", "maximum": 1000000, "minimum": 0, @@ -14242,9 +14247,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 16000, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-default": 16000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -14307,7 +14312,7 @@ "maxTransactedSessionCount": { "description": "The maximum number of transacted sessions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`.", "format": "int64", - "maximum": 30000, + "maximum": 100000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -14332,7 +14337,7 @@ "maxTransactionCount": { "description": "The maximum number of transactions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", "format": "int64", - "maximum": 50000, + "maximum": 100000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -14624,7 +14629,7 @@ "x-writeOnly": false }, "rejectMsgToSenderOnNoSubscriptionMatchEnabled": { - "description": "Enable or disable the sending of a negative acknowledgment (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2.", + "description": "Enable or disable the sending of a negative acknowledgment (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -16684,8 +16689,10 @@ "x-writeOnly": false }, "cacheVirtualRouter": { - "description": "The virtual router of the Distributed Cache. The default value is `\"auto\"`. The allowed values and their meaning are:\n\n
\n\"auto\" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n Available since 2.28.", + "description": "The virtual router of the Distributed Cache. The default value is `\"auto\"`. The allowed values and their meaning are:\n\n
\n\"primary\" - The Distributed Cache is used for the primary virtual router.\n\"backup\" - The Distributed Cache is used for the backup virtual router.\n\"auto\" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n Available since 2.28.", "enum": [ + "primary", + "backup", "auto" ], "type": "string", @@ -19305,7 +19312,7 @@ "type": "object" }, "MsgVpnEventServiceAmqpConnectionCountThreshold": { - "description": "The thresholds for the AMQP client connection count event of the Message VPN, relative to `serviceAmqpMaxConnectionCount`. Available since 2.7.", + "description": "The thresholds for the AMQP client connection count event of the Message VPN, relative to `serviceAmqpMaxConnectionCount`. Available since 2.8.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -19435,7 +19442,7 @@ "type": "object" }, "MsgVpnEventServiceMqttConnectionCountThreshold": { - "description": "The thresholds for the MQTT client connection count event of the Message VPN, relative to `serviceMqttMaxConnectionCount`. Available since 2.1.", + "description": "The thresholds for the MQTT client connection count event of the Message VPN, relative to `serviceMqttMaxConnectionCount`. Available since 2.4.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -20370,7 +20377,7 @@ "MsgVpnJndiConnectionFactory": { "properties": { "allowDuplicateClientIdEnabled": { - "description": "Enable or disable whether new JMS connections can use the same Client identifier (ID) as an existing connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.3.", + "description": "Enable or disable whether new JMS connections can use the same Client identifier (ID) as an existing connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -21624,128 +21631,149 @@ ], "type": "object" }, - "MsgVpnKafkaReceiver": { + "MsgVpnLinks": { "properties": { - "authenticationBasicPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "authenticationBasicUsername" - ], - "x-requiresDisable": [], - "x-writeOnly": true + "aclProfilesUri": { + "description": "The URI of this Message VPN's collection of ACL Profile objects.", + "type": "string" }, - "authenticationBasicUsername": { - "description": "The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "authenticationOauthProfilesUri": { + "description": "The URI of this Message VPN's collection of OAuth Profile objects. Available since 2.25.", + "type": "string" }, - "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", - "maxLength": 32768, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true + "authenticationOauthProvidersUri": { + "description": "The URI of this Message VPN's collection of OAuth Provider objects. Deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "type": "string" }, - "authenticationClientCertPassword": { - "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", - "maxLength": 512, - "minLength": 0, + "authorizationGroupsUri": { + "description": "The URI of this Message VPN's collection of Authorization Group objects.", + "type": "string" + }, + "bridgesUri": { + "description": "The URI of this Message VPN's collection of Bridge objects.", + "type": "string" + }, + "certMatchingRulesUri": { + "description": "The URI of this Message VPN's collection of Certificate Matching Rule objects. Available since 2.27.", + "type": "string" + }, + "clientProfilesUri": { + "description": "The URI of this Message VPN's collection of Client Profile objects.", + "type": "string" + }, + "clientUsernamesUri": { + "description": "The URI of this Message VPN's collection of Client Username objects.", + "type": "string" + }, + "distributedCachesUri": { + "description": "The URI of this Message VPN's collection of Distributed Cache objects. Available since 2.11.", + "type": "string" + }, + "dmrBridgesUri": { + "description": "The URI of this Message VPN's collection of DMR Bridge objects. Available since 2.11.", + "type": "string" + }, + "jndiConnectionFactoriesUri": { + "description": "The URI of this Message VPN's collection of JNDI Connection Factory objects. Available since 2.4.", + "type": "string" + }, + "jndiQueuesUri": { + "description": "The URI of this Message VPN's collection of JNDI Queue objects. Available since 2.4.", + "type": "string" + }, + "jndiTopicsUri": { + "description": "The URI of this Message VPN's collection of JNDI Topic objects. Available since 2.4.", + "type": "string" + }, + "mqttRetainCachesUri": { + "description": "The URI of this Message VPN's collection of MQTT Retain Cache objects. Available since 2.11.", + "type": "string" + }, + "mqttSessionsUri": { + "description": "The URI of this Message VPN's collection of MQTT Session objects. Available since 2.4.", + "type": "string" + }, + "proxiesUri": { + "description": "The URI of this Message VPN's collection of Proxy objects. Available since 2.36.", + "type": "string" + }, + "queueTemplatesUri": { + "description": "The URI of this Message VPN's collection of Queue Template objects. Available since 2.14.", + "type": "string" + }, + "queuesUri": { + "description": "The URI of this Message VPN's collection of Queue objects.", + "type": "string" + }, + "replayLogsUri": { + "description": "The URI of this Message VPN's collection of Replay Log objects. Available since 2.10.", + "type": "string" + }, + "replicatedTopicsUri": { + "description": "The URI of this Message VPN's collection of Replicated Topic objects. Available since 2.4.", + "type": "string" + }, + "restDeliveryPointsUri": { + "description": "The URI of this Message VPN's collection of REST Delivery Point objects.", + "type": "string" + }, + "sequencedTopicsUri": { + "description": "The URI of this Message VPN's collection of Sequenced Topic objects.", + "type": "string" + }, + "telemetryProfilesUri": { + "description": "The URI of this Message VPN's collection of Telemetry Profile objects. Available since 2.31.", + "type": "string" + }, + "topicEndpointTemplatesUri": { + "description": "The URI of this Message VPN's collection of Topic Endpoint Template objects. Available since 2.14.", + "type": "string" + }, + "topicEndpointsUri": { + "description": "The URI of this Message VPN's collection of Topic Endpoint objects. Available since 2.4.", + "type": "string" + }, + "uri": { + "description": "The URI of this Message VPN object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttRetainCache": { + "properties": { + "cacheName": { + "description": "The name of the MQTT Retain Cache.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "authenticationClientCertContent" - ], + "x-readOptional": false, + "x-requiredPost": true, "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationOauthClientId": { - "description": "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", + "enabled": { + "description": "Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -21757,21 +21785,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationOauthClientScope": { - "description": "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", + "msgLifetime": { + "description": "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 4294967294, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -21783,47 +21810,97 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationOauthClientSecret": { - "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 512, - "minLength": 0, + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": true - }, - "authenticationOauthClientTokenEndpoint": { - "description": "The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 2048, - "minLength": 0, - "pattern": "^([hH][tT][tT][pP][sS]://.+)?$", - "type": "string", + "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnMqttRetainCacheLinks": { + "properties": { + "uri": { + "description": "The URI of this MQTT Retain Cache object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttRetainCacheResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnMqttRetainCache" + }, + "links": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttRetainCachesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnMqttRetainCache" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttSession": { + "properties": { + "enabled": { + "description": "Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -21835,96 +21912,73 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationScheme": { - "description": "The authentication scheme for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication.\n\"basic\" - Basic Authentication.\n\"scram\" - Salted Challenge Response Authentication.\n\"client-certificate\" - Client Certificate Authentication.\n\"oauth-client\" - Oauth Authentication.\n
\n", - "enum": [ - "none", - "basic", - "scram", - "client-certificate", - "oauth-client" - ], + "mqttSessionClientId": { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "maxLength": 128, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "none", - "x-configSyncTableType": "vpn", - "x-default": "none", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationScramHash": { - "description": "The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", + "mqttSessionVirtualRouter": { + "description": "The virtual router of the MQTT Session. The allowed values and their meaning are:\n\n
\n\"primary\" - The MQTT Session belongs to the primary virtual router.\n\"backup\" - The MQTT Session belongs to the backup virtual router.\n\"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", "enum": [ - "sha-256", - "sha-512" + "primary", + "backup", + "auto" ], "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "sha-512", - "x-configSyncTableType": "vpn", - "x-default": "sha-512", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationScramPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "authenticationScramUsername" - ], "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationScramUsername": { - "description": "The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, + "owner": { + "description": "The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 189, "minLength": 0, "type": "string", "x-accessLevels": { @@ -21948,22 +22002,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "batchDelay": { - "description": "Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`.", - "format": "int32", - "maximum": 300000, - "minimum": 0, - "type": "integer", + "queueConsumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 500, + "x-autoDisable": [], + "x-configSyncDefault": true, "x-configSyncTableType": "vpn", - "x-default": 500, + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -21975,22 +22024,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "batchMaxSize": { - "description": "Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", - "format": "int32", - "maximum": 100000000, - "minimum": 1, - "type": "integer", + "queueDeadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 1, + "x-autoDisable": [], + "x-configSyncDefault": "#DEAD_MSG_QUEUE", "x-configSyncTableType": "vpn", - "x-default": 1, + "x-default": "#DEAD_MSG_QUEUE", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22002,22 +22049,29 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "bootstrapAddressList": { - "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 1044, - "minLength": 0, - "pattern": "^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", - "type": "string", + "queueEventBindCountThreshold": { + "$ref": "#/definitions/MsgVpnMqttSessionQueueEventBindCountThreshold" + }, + "queueEventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/MsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold" + }, + "queueEventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/MsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold" + }, + "queueMaxBindCount": { + "description": "The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14.", + "format": "int64", + "maximum": 10000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": 1000, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 1000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22029,17 +22083,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "enabled": { - "description": "Enable or disable the Kafka Receiver. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "queueMaxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14.", + "format": "int64", + "maximum": 1000000, + "minimum": 1, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": false, + "x-configSyncDefault": 10000, "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": 10000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22051,21 +22108,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "groupId": { - "description": "The id of the Kafka consumer group for the Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 100, - "minLength": 0, - "type": "string", + "queueMaxMsgSize": { + "description": "The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14.", + "format": "int32", + "maximum": 30000000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": 10000000, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 10000000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22077,22 +22133,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "groupKeepaliveInterval": { - "description": "The time between sending keepalives to the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", - "format": "int32", - "maximum": 3600000, - "minimum": 1, + "queueMaxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14.", + "format": "int64", + "maximum": 6000000, + "minimum": 0, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 3000, + "x-autoDisable": [], + "x-configSyncDefault": 4000, "x-configSyncTableType": "vpn", - "x-default": 3000, + "x-default": 5000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22104,22 +22158,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "groupKeepaliveTimeout": { - "description": "The time until unresponsive group members are removed, triggering a partition rebalance across other members of the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`.", - "format": "int32", - "maximum": 3600000, - "minimum": 1, + "queueMaxRedeliveryCount": { + "description": "The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", + "format": "int64", + "maximum": 255, + "minimum": 0, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 45000, + "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": 45000, + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22131,23 +22183,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "groupMembershipType": { - "description": "The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within groupKeepaliveTimeout) without prompting a group rebalance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"dynamic\"`. The allowed values and their meaning are:\n\n
\n\"dynamic\" - Dynamic Membership.\n\"static\" - Static Membership.\n
\n", - "enum": [ - "dynamic", - "static" - ], - "type": "string", + "queueMaxTtl": { + "description": "The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", + "format": "int64", + "maximum": 9223372036854775807, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "dynamic", + "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": "dynamic", + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22159,21 +22208,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "groupPartitionSchemeList": { - "description": "The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager (\"range\", \"roundrobin\") and Cooperative (\"cooperative-sticky\") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"range,roundrobin\"`.", - "maxLength": 64, - "minLength": 0, - "type": "string", + "queueRejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "range,roundrobin", + "x-autoDisable": [], + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": "range,roundrobin", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22185,43 +22230,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "kafkaReceiverName": { - "description": "The name of the Kafka Receiver.", - "maxLength": 100, - "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "metadataTopicExcludeList": { - "description": "A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 1023, - "minLength": 0, - "pattern": "^(((\\^.*|[a-zA-Z0-9\\._\\-]+),)*(\\^.*|[a-zA-Z0-9\\._\\-]+))?$", - "type": "string", + "queueRejectLowPriorityMsgLimit": { + "description": "The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22233,22 +22255,24 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "metadataTopicRefreshInterval": { - "description": "The time between refreshes of topic metadata from the Kafka Cluster. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`.", - "format": "int32", - "maximum": 3600000, - "minimum": 1000, - "type": "integer", + "queueRejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as queueRejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-queue-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n Available since 2.14.", + "enum": [ + "never", + "when-queue-enabled", + "always" + ], + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ - "enabled" + "queueRejectLowPriorityMsgEnabled" ], - "x-configSyncDefault": 30000, + "x-configSyncDefault": "when-queue-enabled", "x-configSyncTableType": "vpn", - "x-default": 30000, + "x-default": "when-queue-enabled", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22260,37 +22284,14 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "transportTlsEnabled": { - "description": "Enable or disable encryption (TLS) for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "queueRespectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], + "x-autoDisable": [], "x-configSyncDefault": false, "x-configSyncTableType": "vpn", "x-default": false, @@ -22313,163 +22314,473 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnKafkaReceiverLinks": { + "MsgVpnMqttSessionLinks": { "properties": { - "topicBindingsUri": { - "description": "The URI of this Kafka Receiver's collection of Topic Binding objects.", + "subscriptionsUri": { + "description": "The URI of this MQTT Session's collection of Subscription objects.", "type": "string" }, "uri": { - "description": "The URI of this Kafka Receiver object.", + "description": "The URI of this MQTT Session object.", "type": "string" } }, "type": "object" }, - "MsgVpnKafkaReceiverResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnKafkaReceiver" - }, - "links": { - "$ref": "#/definitions/MsgVpnKafkaReceiverLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnKafkaReceiverTopicBinding": { + "MsgVpnMqttSessionQueueEventBindCountThreshold": { + "description": "Thresholds for the high number of the MQTT Session Queue Consumers Event, relative to `queueMaxBindCount`. Available since 2.14.", "properties": { - "enabled": { - "description": "Enable or disable this topic binding of the Kafka Receiver. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": false, + "x-configSyncDefault": 60, "x-configSyncTableType": "vpn", - "x-default": false, + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "initialOffset": { - "description": "The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"end\"`. The allowed values and their meaning are:\n\n
\n\"beginning\" - Start with the earliest offset available.\n\"end\" - Start with new offsets only.\n
\n", - "enum": [ - "beginning", - "end" - ], - "type": "string", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "end", + "x-autoDisable": [], "x-configSyncTableType": "vpn", - "x-default": "end", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "kafkaReceiverName": { - "description": "The name of the Kafka Receiver.", - "maxLength": 100, - "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "localKey": { - "description": "The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, no key is included for each message as it is published into Solace.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 1024, - "minLength": 0, - "type": "string", + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": 80, "x-configSyncTableType": "vpn", - "x-default": "", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "localTopic": { - "description": "The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, the Topic Binding will not be operational.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 1024, - "minLength": 0, - "type": "string", + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], "x-configSyncTableType": "vpn", - "x-default": "", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], "x-requiresDisable": [], "x-writeOnly": false - }, - "msgVpnName": { - "description": "The name of the Message VPN.", + } + }, + "type": "object" + }, + "MsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold": { + "description": "The threshold for the Message Spool usage event of the MQTT Session Queue, relative to `queueMaxMsgSpoolUsage`. Available since 2.14.", + "properties": { + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 60, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 18, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], + "x-requiresDisable": [], + "x-writeOnly": false + }, + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false + }, + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 80, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 25, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], + "x-requiresDisable": [], + "x-writeOnly": false + }, + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false + } + }, + "type": "object" + }, + "MsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold": { + "description": "The threshold for the maximum allowed number of any priority messages queued in the MQTT Session Queue, relative to `queueRejectLowPriorityMsgLimit`. Available since 2.14.", + "properties": { + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 60, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], + "x-requiresDisable": [], + "x-writeOnly": false + }, + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false + }, + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 80, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], + "x-requiresDisable": [], + "x-writeOnly": false + }, + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false + } + }, + "type": "object" + }, + "MsgVpnMqttSessionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnMqttSession" + }, + "links": { + "$ref": "#/definitions/MsgVpnMqttSessionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttSessionSubscription": { + "properties": { + "mqttSessionClientId": { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "maxLength": 128, + "minLength": 1, + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only" + }, + "x-autoDisable": [], + "x-deprecated": false, + "x-identifying": true, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "mqttSessionVirtualRouter": { + "description": "The virtual router of the MQTT Session. The allowed values and their meaning are:\n\n
\n\"primary\" - The MQTT Session belongs to the primary virtual router.\n\"backup\" - The MQTT Session belongs to the backup virtual router.\n\"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", + "enum": [ + "primary", + "backup", + "auto" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only" + }, + "x-autoDisable": [], + "x-deprecated": false, + "x-identifying": true, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "msgVpnName": { + "description": "The name of the Message VPN.", "maxLength": 32, "minLength": 1, "pattern": "^[^*?]+$", @@ -22489,11 +22800,35 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "topicName": { - "description": "The name of the Topic.", - "maxLength": 255, + "subscriptionQos": { + "description": "The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 1, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "subscriptionTopic": { + "description": "The MQTT subscription topic.", + "maxLength": 250, "minLength": 1, - "pattern": "^\\^.*|[a-zA-Z0-9\\._\\-]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -22518,22 +22853,45 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnKafkaReceiverTopicBindingLinks": { + "MsgVpnMqttSessionSubscriptionLinks": { "properties": { "uri": { - "description": "The URI of this Topic Binding object.", + "description": "The URI of this Subscription object.", "type": "string" } }, "type": "object" }, - "MsgVpnKafkaReceiverTopicBindingResponse": { + "MsgVpnMqttSessionSubscriptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscription" + }, + "links": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttSessionSubscriptionsResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBinding" + "items": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscription" + }, + "type": "array" }, "links": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBindingLinks" + "items": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionLinks" + }, + "type": "array" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -22544,17 +22902,17 @@ ], "type": "object" }, - "MsgVpnKafkaReceiverTopicBindingsResponse": { + "MsgVpnMqttSessionsResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBinding" + "$ref": "#/definitions/MsgVpnMqttSession" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBindingLinks" + "$ref": "#/definitions/MsgVpnMqttSessionLinks" }, "type": "array" }, @@ -22567,17 +22925,17 @@ ], "type": "object" }, - "MsgVpnKafkaReceiversResponse": { + "MsgVpnProxiesResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/MsgVpnKafkaReceiver" + "$ref": "#/definitions/MsgVpnProxy" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/MsgVpnKafkaReceiverLinks" + "$ref": "#/definitions/MsgVpnProxyLinks" }, "type": "array" }, @@ -22590,21 +22948,19 @@ ], "type": "object" }, - "MsgVpnKafkaSender": { + "MsgVpnProxy": { "properties": { "authenticationBasicPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, + "description": "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 64, "minLength": 0, "type": "string", "x-accessLevels": { "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], + "x-autoDisable": [], "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", + "x-configSyncTableType": "router", "x-default": "", "x-deprecated": false, "x-identifying": false, @@ -22614,26 +22970,21 @@ "x-readOnlyPost": false, "x-readOptional": true, "x-requiredPost": false, - "x-requires": [ - "authenticationBasicUsername" - ], "x-requiresDisable": [], "x-writeOnly": true }, "authenticationBasicUsername": { - "description": "The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, + "description": "The username to use with basic authentication. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 32, "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], + "x-autoDisable": [], "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", + "x-configSyncTableType": "router", "x-default": "", "x-deprecated": false, "x-identifying": false, @@ -22646,71 +22997,67 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", - "maxLength": 32768, - "minLength": 0, + "authenticationScheme": { + "description": "The authentication scheme used to connect to the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - No authentication.\n\"basic\" - Username/password authentication.\n
\n", + "enum": [ + "none", + "basic" + ], "type": "string", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", + "x-autoDisable": [], + "x-configSyncDefault": "none", + "x-configSyncTableType": "router", + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": true, + "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationClientCertPassword": { - "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", - "maxLength": 512, - "minLength": 0, - "type": "string", + "enabled": { + "description": "Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "router", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "authenticationClientCertContent" - ], "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationOauthClientId": { - "description": "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, + "host": { + "description": "The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 253, "minLength": 0, + "pattern": "^([0-9a-zA-Z\\-\\.]*|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,7}:|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|:((:[0-9a-fA-F]{1,4}){1,7}|:)|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], + "x-autoDisable": [], "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", + "x-configSyncTableType": "router", "x-default": "", "x-deprecated": false, "x-identifying": false, @@ -22723,73 +23070,41 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationOauthClientScope": { - "description": "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationOauthClientSecret": { - "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 512, - "minLength": 0, - "type": "string", + "port": { + "description": "The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.", + "format": "int32", + "maximum": 65535, + "minimum": 0, + "type": "integer", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true - }, - "authenticationOauthClientTokenEndpoint": { - "description": "The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 2048, - "minLength": 0, - "pattern": "^([hH][tT][tT][pP][sS]://.+)?$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "router", + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22801,54 +23116,42 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationScheme": { - "description": "The authentication scheme for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication.\n\"basic\" - Basic Authentication.\n\"scram\" - Salted Challenge Response Authentication.\n\"client-certificate\" - Client Certificate Authentication.\n\"oauth-client\" - Oauth Authentication.\n
\n", - "enum": [ - "none", - "basic", - "scram", - "client-certificate", - "oauth-client" - ], + "proxyName": { + "description": "The name of the proxy.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^#*? ]([^*?]*[^*? ])?$", "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "none", - "x-configSyncTableType": "vpn", - "x-default": "none", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationScramHash": { - "description": "The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", + "proxyType": { + "description": "The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"direct\"`. The allowed values and their meaning are:\n\n
\n\"direct\" - Direct connection (no proxy).\n\"http\" - HTTP proxy.\n
\n", "enum": [ - "sha-256", - "sha-512" + "direct", + "http" ], "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "sha-512", - "x-configSyncTableType": "vpn", - "x-default": "sha-512", + "x-autoDisable": [], + "x-configSyncDefault": "direct", + "x-configSyncTableType": "router", + "x-default": "direct", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22859,50 +23162,60 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "MsgVpnProxyLinks": { + "properties": { + "uri": { + "description": "The URI of this Proxy object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnProxyResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnProxy" }, - "authenticationScramPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "authenticationScramUsername" - ], - "x-requiresDisable": [], - "x-writeOnly": true + "links": { + "$ref": "#/definitions/MsgVpnProxyLinks" }, - "authenticationScramUsername": { - "description": "The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnQueue": { + "properties": { + "accessType": { + "description": "The access type for delivering messages to consumer flows bound to the Queue. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n", + "enum": [ + "exclusive", + "non-exclusive" + ], "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ - "enabled" + "egressEnabled" ], - "x-configSyncDefault": "", + "x-configSyncDefault": "exclusive", "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": "exclusive", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22914,22 +23227,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "batchDelay": { - "description": "Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", - "format": "int32", - "maximum": 900000, - "minimum": 0, - "type": "integer", + "consumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 5, + "x-autoDisable": [], + "x-configSyncDefault": true, "x-configSyncTableType": "vpn", - "x-default": 5, + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22941,22 +23249,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "batchMaxMsgCount": { - "description": "Maximum number of messages sent in a single batch. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", - "format": "int32", - "maximum": 1000000, - "minimum": 1, - "type": "integer", + "deadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 10000, + "x-autoDisable": [], + "x-configSyncDefault": "#DEAD_MSG_QUEUE", "x-configSyncTableType": "vpn", - "x-default": 10000, + "x-default": "#DEAD_MSG_QUEUE", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22968,22 +23274,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "batchMaxSize": { - "description": "Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", - "format": "int32", - "maximum": 2147483647, - "minimum": 1, - "type": "integer", + "deliveryCountEnabled": { + "description": "Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 1000000, + "x-autoDisable": [], + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": 1000000, + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22995,22 +23296,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "bootstrapAddressList": { - "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 1044, - "minLength": 0, - "pattern": "^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", - "type": "string", + "deliveryDelay": { + "description": "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23022,8 +23321,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "enabled": { - "description": "Enable or disable the Kafka Sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "egressEnabled": { + "description": "Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -23044,16 +23343,23 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "idempotenceEnabled": { - "description": "Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "eventBindCountThreshold": { + "$ref": "#/definitions/MsgVpnQueueEventBindCountThreshold" + }, + "eventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/MsgVpnQueueEventMsgSpoolUsageThreshold" + }, + "eventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/MsgVpnQueueEventRejectLowPriorityMsgLimitThreshold" + }, + "ingressEnabled": { + "description": "Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], + "x-autoDisable": [], "x-configSyncDefault": false, "x-configSyncTableType": "vpn", "x-default": false, @@ -23068,61 +23374,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "kafkaSenderName": { - "description": "The name of the Kafka Sender.", - "maxLength": 100, - "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "transportCompressionEnabled": { - "description": "Enable or disable compression for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "maxBindCount": { + "description": "The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "maximum": 10000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": false, + "x-autoDisable": [], + "x-configSyncDefault": 1000, "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": 1000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23134,22 +23399,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "transportCompressionLevel": { - "description": "Compression level. The valid range is dependent on the compression type. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", - "format": "int32", - "maximum": 22, - "minimum": -1, + "maxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "format": "int64", + "maximum": 1000000, + "minimum": 1, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": -1, + "x-autoDisable": [], + "x-configSyncDefault": 10000, "x-configSyncTableType": "vpn", - "x-default": -1, + "x-default": 10000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23161,25 +23424,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "transportCompressionType": { - "description": "Compression type. Only relevant if compression is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"gzip\"`. The allowed values and their meaning are:\n\n
\n\"gzip\" - GZIP Compression.\n\"snappy\" - Snappy Compression.\n\"lz4\" - LZ4 Compression.\n\"zstd\" - Zstandard Compression.\n
\n", - "enum": [ - "gzip", - "snappy", - "lz4", - "zstd" - ], - "type": "string", + "maxMsgSize": { + "description": "The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "format": "int32", + "maximum": 30000000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "gzip", + "x-autoDisable": [], + "x-configSyncDefault": 10000000, "x-configSyncTableType": "vpn", - "x-default": "gzip", + "x-default": 10000000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23191,19 +23449,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "transportTlsEnabled": { - "description": "Enable or disable encryption (TLS) for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "maxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "format": "int64", + "maximum": 6000000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": false, + "x-autoDisable": [], + "x-configSyncDefault": 4000, "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": 5000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23214,48 +23473,21 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnKafkaSenderLinks": { - "properties": { - "queueBindingsUri": { - "description": "The URI of this Kafka Sender's collection of Queue Binding objects.", - "type": "string" }, - "uri": { - "description": "The URI of this Kafka Sender object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnKafkaSenderQueueBinding": { - "properties": { - "ackMode": { - "description": "The number of acks required from the remote Kafka Broker. When \"none\" messages are delivered at-most-once. When \"one\" or \"all\" messages are delivered at-least-once but may be reordered. This is overridden to \"all\" for an idempotent Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are:\n\n
\n\"none\" - No Acks.\n\"one\" - Leader Ack Only.\n\"all\" - All Replica Acks.\n
\n", - "enum": [ - "none", - "one", - "all" - ], - "type": "string", + "maxRedeliveryCount": { + "description": "The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 255, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "all", + "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": "all", + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23267,17 +23499,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "enabled": { - "description": "Enable or disable this queue binding of the Kafka Sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "maxTtl": { + "description": "The maximum time in seconds a message can stay in the Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": false, + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23289,11 +23524,11 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "kafkaSenderName": { - "description": "The name of the Kafka Sender.", - "maxLength": 100, + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -23310,45 +23545,46 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", + "owner": { + "description": "The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 189, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "partitionConsistentHash": { - "description": "The hash algorithm to use for consistent partition selection. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"crc\"`. The allowed values and their meaning are:\n\n
\n\"crc\" - CRC Hash.\n\"murmur2\" - Murmer2 Hash.\n\"fnv1a\" - Fowler-Noll-Vo 1a Hash.\n
\n", - "enum": [ - "crc", - "murmur2", - "fnv1a" - ], - "type": "string", + "partitionCount": { + "description": "The count of partitions of the queue. Only relevant for queues with an access type of non-exclusive. When zero, bound clients receive messages round-robin. Otherwise, bound clients receive messages from individually assigned partitions. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.35.", + "format": "int32", + "maximum": 1000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "crc", + "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": "crc", + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23360,8 +23596,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "partitionExplicitNumber": { - "description": "The partition number to use for explicit partition selection. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "partitionRebalanceDelay": { + "description": "The delay (in seconds) before a partition rebalance is started once needed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`. Available since 2.35.", "format": "int64", "maximum": 4294967295, "minimum": 0, @@ -23370,12 +23606,10 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 0, + "x-autoDisable": [], + "x-configSyncDefault": 5, "x-configSyncTableType": "vpn", - "x-default": 0, + "x-default": 5, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23387,19 +23621,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "partitionRandomFallbackEnabled": { - "description": "Enable or disable fallback to the random partition selection scheme when the consistent partition scheme is being used but no partition key is available for the message. When enabled a random partition will be selected for each unkeyed messages, otherwise some partition will be selected for groups of unkeyed messages. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", - "type": "boolean", + "partitionRebalanceMaxHandoffTime": { + "description": "The maximum time (in seconds) to wait before handing off a partition while rebalancing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. Available since 2.35.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": true, + "x-autoDisable": [], + "x-configSyncDefault": 3, "x-configSyncTableType": "vpn", - "x-default": true, + "x-default": 3, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23411,12 +23646,14 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "partitionScheme": { - "description": "The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"consistent\"`. The allowed values and their meaning are:\n\n
\n\"consistent\" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number.\n\"explicit\" - Select an explicit partition independent of key value.\n\"random\" - Select a random partition independent of key value.\n
\n", + "permission": { + "description": "The permission level for all consumers of the Queue, excluding the owner. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", "enum": [ - "consistent", - "explicit", - "random" + "no-access", + "read-only", + "consume", + "modify-topic", + "delete" ], "type": "string", "x-accessLevels": { @@ -23424,11 +23661,11 @@ "patch": "vpn/read-write" }, "x-autoDisable": [ - "enabled" + "egressEnabled" ], - "x-configSyncDefault": "consistent", + "x-configSyncDefault": "no-access", "x-configSyncTableType": "vpn", - "x-default": "consistent", + "x-default": "no-access", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23461,21 +23698,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "remoteKey": { - "description": "The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue.\n\nIf empty, no key is included for each message as it is published into Kafka.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 1024, - "minLength": 0, - "type": "string", + "redeliveryDelayEnabled": { + "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ - "enabled" + "egressEnabled" ], - "x-configSyncDefault": "", + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23487,22 +23722,22 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "remoteTopic": { - "description": "The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to.\n\nIf empty, the Queue Binding will not be operational.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 249, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\._\\-]*$", - "type": "string", + "redeliveryDelayInitialInterval": { + "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", + "format": "int32", + "maximum": 3600000, + "minimum": 1, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ - "enabled" + "egressEnabled" ], - "x-configSyncDefault": "", + "x-configSyncDefault": 1000, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 1000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23513,255 +23748,23 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnKafkaSenderQueueBindingLinks": { - "properties": { - "uri": { - "description": "The URI of this Queue Binding object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnKafkaSenderQueueBindingResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBinding" }, - "links": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBindingLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnKafkaSenderQueueBindingsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBinding" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBindingLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnKafkaSenderResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnKafkaSender" - }, - "links": { - "$ref": "#/definitions/MsgVpnKafkaSenderLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnKafkaSendersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnKafkaSender" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnKafkaSenderLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnLinks": { - "properties": { - "aclProfilesUri": { - "description": "The URI of this Message VPN's collection of ACL Profile objects.", - "type": "string" - }, - "authenticationOauthProfilesUri": { - "description": "The URI of this Message VPN's collection of OAuth Profile objects. Available since 2.25.", - "type": "string" - }, - "authenticationOauthProvidersUri": { - "description": "The URI of this Message VPN's collection of OAuth Provider objects. Deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "type": "string" - }, - "authorizationGroupsUri": { - "description": "The URI of this Message VPN's collection of Authorization Group objects.", - "type": "string" - }, - "bridgesUri": { - "description": "The URI of this Message VPN's collection of Bridge objects.", - "type": "string" - }, - "certMatchingRulesUri": { - "description": "The URI of this Message VPN's collection of Certificate Matching Rule objects. Available since 2.27.", - "type": "string" - }, - "clientProfilesUri": { - "description": "The URI of this Message VPN's collection of Client Profile objects.", - "type": "string" - }, - "clientUsernamesUri": { - "description": "The URI of this Message VPN's collection of Client Username objects.", - "type": "string" - }, - "distributedCachesUri": { - "description": "The URI of this Message VPN's collection of Distributed Cache objects. Available since 2.11.", - "type": "string" - }, - "dmrBridgesUri": { - "description": "The URI of this Message VPN's collection of DMR Bridge objects. Available since 2.11.", - "type": "string" - }, - "jndiConnectionFactoriesUri": { - "description": "The URI of this Message VPN's collection of JNDI Connection Factory objects. Available since 2.2.", - "type": "string" - }, - "jndiQueuesUri": { - "description": "The URI of this Message VPN's collection of JNDI Queue objects. Available since 2.2.", - "type": "string" - }, - "jndiTopicsUri": { - "description": "The URI of this Message VPN's collection of JNDI Topic objects. Available since 2.2.", - "type": "string" - }, - "kafkaReceiversUri": { - "description": "The URI of this Message VPN's collection of Kafka Receiver objects. Available since 2.36.", - "type": "string" - }, - "kafkaSendersUri": { - "description": "The URI of this Message VPN's collection of Kafka Sender objects. Available since 2.36.", - "type": "string" - }, - "mqttRetainCachesUri": { - "description": "The URI of this Message VPN's collection of MQTT Retain Cache objects. Available since 2.11.", - "type": "string" - }, - "mqttSessionsUri": { - "description": "The URI of this Message VPN's collection of MQTT Session objects. Available since 2.1.", - "type": "string" - }, - "proxiesUri": { - "description": "The URI of this Message VPN's collection of Proxy objects. Available since 2.36.", - "type": "string" - }, - "queueTemplatesUri": { - "description": "The URI of this Message VPN's collection of Queue Template objects. Available since 2.14.", - "type": "string" - }, - "queuesUri": { - "description": "The URI of this Message VPN's collection of Queue objects.", - "type": "string" - }, - "replayLogsUri": { - "description": "The URI of this Message VPN's collection of Replay Log objects. Available since 2.10.", - "type": "string" - }, - "replicatedTopicsUri": { - "description": "The URI of this Message VPN's collection of Replicated Topic objects. Available since 2.1.", - "type": "string" - }, - "restDeliveryPointsUri": { - "description": "The URI of this Message VPN's collection of REST Delivery Point objects.", - "type": "string" - }, - "sequencedTopicsUri": { - "description": "The URI of this Message VPN's collection of Sequenced Topic objects.", - "type": "string" - }, - "telemetryProfilesUri": { - "description": "The URI of this Message VPN's collection of Telemetry Profile objects. Available since 2.31.", - "type": "string" - }, - "topicEndpointTemplatesUri": { - "description": "The URI of this Message VPN's collection of Topic Endpoint Template objects. Available since 2.14.", - "type": "string" - }, - "topicEndpointsUri": { - "description": "The URI of this Message VPN's collection of Topic Endpoint objects. Available since 2.1.", - "type": "string" - }, - "uri": { - "description": "The URI of this Message VPN object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnMqttRetainCache": { - "properties": { - "cacheName": { - "description": "The name of the MQTT Retain Cache.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "enabled": { - "description": "Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "redeliveryDelayMaxInterval": { + "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", + "format": "int32", + "maximum": 10800000, + "minimum": 1, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], - "x-configSyncDefault": false, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": 64000, "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": 64000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23773,20 +23776,22 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "msgLifetime": { - "description": "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 4294967294, - "minimum": 0, + "redeliveryDelayMultiplier": { + "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", + "format": "int32", + "maximum": 500, + "minimum": 100, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], - "x-configSyncDefault": 0, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": 200, "x-configSyncTableType": "vpn", - "x-default": 0, + "x-default": 200, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23798,88 +23803,30 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "redeliveryEnabled": { + "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": true, + "x-configSyncTableType": "vpn", + "x-default": true, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnMqttRetainCacheLinks": { - "properties": { - "uri": { - "description": "The URI of this MQTT Retain Cache object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnMqttRetainCacheResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnMqttRetainCache" - }, - "links": { - "$ref": "#/definitions/MsgVpnMqttRetainCacheLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnMqttRetainCachesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnMqttRetainCache" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnMqttRetainCacheLinks" - }, - "type": "array" }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnMqttSession": { - "properties": { - "enabled": { - "description": "Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "rejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -23900,85 +23847,49 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "mqttSessionClientId": { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "maxLength": 128, - "minLength": 1, - "type": "string", + "rejectLowPriorityMsgLimit": { + "description": "The number of messages of any priority in the Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "mqttSessionVirtualRouter": { - "description": "The virtual router of the MQTT Session. The allowed values and their meaning are:\n\n
\n\"primary\" - The MQTT Session belongs to the primary virtual router.\n\"backup\" - The MQTT Session belongs to the backup virtual router.\n\"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", + "rejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as rejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-queue-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n", "enum": [ - "primary", - "backup", - "auto" + "never", + "when-queue-enabled", + "always" ], "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "owner": { - "description": "The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 189, - "minLength": 0, - "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ - "enabled" + "rejectLowPriorityMsgEnabled" ], - "x-configSyncDefault": "", + "x-configSyncDefault": "when-queue-enabled", "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": "when-queue-enabled", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -23990,17 +23901,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "queueConsumerAckPropagationEnabled": { - "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14.", + "respectMsgPriorityEnabled": { + "description": "Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). Regardless of this setting, message priority is not respected when browsing the queue, when the queue is used by a bridge, or if the queue is partitioned. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled and ingressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], - "x-configSyncDefault": true, + "x-autoDisable": [ + "egressEnabled", + "ingressEnabled" + ], + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": true, + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -24012,20 +23926,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "queueDeadMsgQueue": { - "description": "The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", - "type": "string", + "respectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "#DEAD_MSG_QUEUE", + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": "#DEAD_MSG_QUEUE", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -24036,20 +23947,22 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - }, - "queueEventBindCountThreshold": { - "$ref": "#/definitions/MsgVpnMqttSessionQueueEventBindCountThreshold" - }, - "queueEventMsgSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold" - }, - "queueEventRejectLowPriorityMsgLimitThreshold": { - "$ref": "#/definitions/MsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold" - }, - "queueMaxBindCount": { - "description": "The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14.", + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnQueueEventBindCountThreshold": { + "description": "The thresholds for the Queue consumer flows event, relative to `maxBindCount`.", + "properties": { + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 10000, + "maximum": 100, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -24057,49 +23970,61 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 60, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "queueMaxDeliveredUnackedMsgsPerFlow": { - "description": "The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14.", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 1000000, - "minimum": 1, + "maximum": 4294967295, + "minimum": 0, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 10000, "x-configSyncTableType": "vpn", - "x-default": 10000, + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "queueMaxMsgSize": { - "description": "The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14.", - "format": "int32", - "maximum": 30000000, + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -24107,24 +24032,31 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 10000000, + "x-configSyncDefault": 80, "x-configSyncTableType": "vpn", - "x-default": 10000000, + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "queueMaxMsgSpoolUsage": { - "description": "The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14.", + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 6000000, + "maximum": 4294967295, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -24132,191 +24064,30 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1500, "x-configSyncTableType": "vpn", - "x-default": 5000, + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], "x-requiresDisable": [], "x-writeOnly": false - }, - "queueMaxRedeliveryCount": { - "description": "The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", - "format": "int64", - "maximum": 255, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "queueMaxTtl": { - "description": "The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", - "format": "int64", - "maximum": 9223372036854775807, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "queueRejectLowPriorityMsgEnabled": { - "description": "Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "queueRejectLowPriorityMsgLimit": { - "description": "The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "queueRejectMsgToSenderOnDiscardBehavior": { - "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as queueRejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-queue-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n Available since 2.14.", - "enum": [ - "never", - "when-queue-enabled", - "always" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "queueRejectLowPriorityMsgEnabled" - ], - "x-configSyncDefault": "when-queue-enabled", - "x-configSyncTableType": "vpn", - "x-default": "when-queue-enabled", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "queueRespectTtlEnabled": { - "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnMqttSessionLinks": { - "properties": { - "subscriptionsUri": { - "description": "The URI of this MQTT Session's collection of Subscription objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this MQTT Session object.", - "type": "string" } }, "type": "object" }, - "MsgVpnMqttSessionQueueEventBindCountThreshold": { - "description": "Thresholds for the high number of the MQTT Session Queue Consumers Event, relative to `queueMaxBindCount`. Available since 2.14.", + "MsgVpnQueueEventMsgSpoolUsageThreshold": { + "description": "The thresholds for the message spool usage event of the Queue, relative to `maxMsgSpoolUsage`.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -24335,7 +24106,7 @@ "clearValue", "setValue" ], - "x-default": 60, + "x-default": 18, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -24397,7 +24168,7 @@ "clearValue", "setValue" ], - "x-default": 80, + "x-default": 25, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -24445,8 +24216,8 @@ }, "type": "object" }, - "MsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold": { - "description": "The threshold for the Message Spool usage event of the MQTT Session Queue, relative to `queueMaxMsgSpoolUsage`. Available since 2.14.", + "MsgVpnQueueEventRejectLowPriorityMsgLimitThreshold": { + "description": "The thresholds for the maximum allowed number of any priority messages queued in the Queue event, relative to `rejectLowPriorityMsgLimit`.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -24465,7 +24236,7 @@ "clearValue", "setValue" ], - "x-default": 18, + "x-default": 60, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -24527,7 +24298,7 @@ "clearValue", "setValue" ], - "x-default": 25, + "x-default": 80, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -24575,143 +24346,26 @@ }, "type": "object" }, - "MsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold": { - "description": "The threshold for the maximum allowed number of any priority messages queued in the MQTT Session Queue, relative to `queueRejectLowPriorityMsgLimit`. Available since 2.14.", + "MsgVpnQueueLinks": { "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false + "subscriptionsUri": { + "description": "The URI of this Queue's collection of Queue Subscription objects.", + "type": "string" }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false + "uri": { + "description": "The URI of this Queue object.", + "type": "string" } }, "type": "object" }, - "MsgVpnMqttSessionResponse": { + "MsgVpnQueueResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnMqttSession" + "$ref": "#/definitions/MsgVpnQueue" }, "links": { - "$ref": "#/definitions/MsgVpnMqttSessionLinks" + "$ref": "#/definitions/MsgVpnQueueLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -24722,12 +24376,13 @@ ], "type": "object" }, - "MsgVpnMqttSessionSubscription": { + "MsgVpnQueueSubscription": { "properties": { - "mqttSessionClientId": { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "maxLength": 128, + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -24744,34 +24399,11 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "mqttSessionVirtualRouter": { - "description": "The virtual router of the MQTT Session. The allowed values and their meaning are:\n\n
\n\"primary\" - The MQTT Session belongs to the primary virtual router.\n\"backup\" - The MQTT Session belongs to the backup virtual router.\n\"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", - "enum": [ - "primary", - "backup", - "auto" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, + "queueName": { + "description": "The name of the Queue.", + "maxLength": 200, "minLength": 1, - "pattern": "^[^*?]+$", + "pattern": "^[^*?'<>&;]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -24788,33 +24420,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "subscriptionQos": { - "description": "The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 1, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, "subscriptionTopic": { - "description": "The MQTT subscription topic.", + "description": "The topic of the Subscription.", "maxLength": 250, "minLength": 1, "type": "string", @@ -24841,68 +24448,22 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnMqttSessionSubscriptionLinks": { + "MsgVpnQueueSubscriptionLinks": { "properties": { "uri": { - "description": "The URI of this Subscription object.", + "description": "The URI of this Queue Subscription object.", "type": "string" } }, "type": "object" }, - "MsgVpnMqttSessionSubscriptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscription" - }, - "links": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnMqttSessionSubscriptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscription" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnMqttSessionsResponse": { + "MsgVpnQueueSubscriptionResponse": { "properties": { "data": { - "items": { - "$ref": "#/definitions/MsgVpnMqttSession" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnQueueSubscription" }, "links": { - "items": { - "$ref": "#/definitions/MsgVpnMqttSessionLinks" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -24913,17 +24474,17 @@ ], "type": "object" }, - "MsgVpnProxiesResponse": { + "MsgVpnQueueSubscriptionsResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/MsgVpnProxy" + "$ref": "#/definitions/MsgVpnQueueSubscription" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/MsgVpnProxyLinks" + "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" }, "type": "array" }, @@ -24936,44 +24497,45 @@ ], "type": "object" }, - "MsgVpnProxy": { + "MsgVpnQueueTemplate": { "properties": { - "authenticationBasicPassword": { - "description": "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, + "accessType": { + "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n", + "enum": [ + "exclusive", + "non-exclusive" + ], "type": "string", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", + "x-configSyncDefault": "exclusive", + "x-configSyncTableType": "vpn", + "x-default": "exclusive", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": true, + "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationBasicUsername": { - "description": "The username to use with basic authentication. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 32, - "minLength": 0, - "type": "string", + "consumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", + "x-configSyncDefault": true, + "x-configSyncTableType": "vpn", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -24985,21 +24547,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationScheme": { - "description": "The authentication scheme used to connect to the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - No authentication.\n\"basic\" - Username/password authentication.\n
\n", - "enum": [ - "none", - "basic" - ], + "deadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "none", - "x-configSyncTableType": "router", - "x-default": "none", + "x-configSyncDefault": "#DEAD_MSG_QUEUE", + "x-configSyncTableType": "vpn", + "x-default": "#DEAD_MSG_QUEUE", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -25011,87 +24572,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "enabled": { - "description": "Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "router", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "host": { - "description": "The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 253, - "minLength": 0, - "pattern": "^([0-9a-zA-Z\\-\\.]*|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,7}:|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|:((:[0-9a-fA-F]{1,4}){1,7}|:)|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "port": { - "description": "The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.", - "format": "int32", - "maximum": 65535, - "minimum": 0, - "type": "integer", + "deliveryDelay": { + "description": "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. This attribute does not apply to MQTT queues created from this template, but it may apply in future releases. Therefore, to maintain forward compatibility, do not set this value on templates that might be used for MQTT queues. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], "x-configSyncDefault": 0, - "x-configSyncTableType": "router", + "x-configSyncTableType": "vpn", "x-default": 0, "x-deprecated": false, "x-identifying": false, @@ -25104,222 +24597,21 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "proxyName": { - "description": "The name of the proxy.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "proxyType": { - "description": "The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"direct\"`. The allowed values and their meaning are:\n\n
\n\"direct\" - Direct connection (no proxy).\n\"http\" - HTTP proxy.\n
\n", - "enum": [ - "direct", - "http" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "direct", - "x-configSyncTableType": "router", - "x-default": "direct", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "MsgVpnProxyLinks": { - "properties": { - "uri": { - "description": "The URI of this Proxy object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnProxyResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnProxy" - }, - "links": { - "$ref": "#/definitions/MsgVpnProxyLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnQueue": { - "properties": { - "accessType": { - "description": "The access type for delivering messages to consumer flows bound to the Queue. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n", + "durabilityOverride": { + "description": "Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - The durability of the endpoint will be as requested on create.\n\"non-durable\" - The durability of the created queue will be non-durable, regardless of what was requested.\n
\n", "enum": [ - "exclusive", - "non-exclusive" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "egressEnabled" + "none", + "non-durable" ], - "x-configSyncDefault": "exclusive", - "x-configSyncTableType": "vpn", - "x-default": "exclusive", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "consumerAckPropagationEnabled": { - "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "vpn", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "deadMsgQueue": { - "description": "The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "#DEAD_MSG_QUEUE", - "x-configSyncTableType": "vpn", - "x-default": "#DEAD_MSG_QUEUE", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "deliveryCountEnabled": { - "description": "Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "deliveryDelay": { - "description": "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "egressEnabled": { - "description": "Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, + "x-configSyncDefault": "none", "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -25332,38 +24624,16 @@ "x-writeOnly": false }, "eventBindCountThreshold": { - "$ref": "#/definitions/MsgVpnQueueEventBindCountThreshold" + "$ref": "#/definitions/MsgVpnQueueTemplateEventBindCountThreshold" }, "eventMsgSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnQueueEventMsgSpoolUsageThreshold" + "$ref": "#/definitions/MsgVpnQueueTemplateEventMsgSpoolUsageThreshold" }, "eventRejectLowPriorityMsgLimitThreshold": { - "$ref": "#/definitions/MsgVpnQueueEventRejectLowPriorityMsgLimitThreshold" - }, - "ingressEnabled": { - "description": "Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "$ref": "#/definitions/MsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold" }, "maxBindCount": { - "description": "The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "description": "The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", "format": "int64", "maximum": 10000, "minimum": 0, @@ -25388,7 +24658,7 @@ "x-writeOnly": false }, "maxDeliveredUnackedMsgsPerFlow": { - "description": "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "description": "The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", "format": "int64", "maximum": 1000000, "minimum": 1, @@ -25413,7 +24683,7 @@ "x-writeOnly": false }, "maxMsgSize": { - "description": "The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "description": "The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", "format": "int32", "maximum": 30000000, "minimum": 0, @@ -25438,7 +24708,7 @@ "x-writeOnly": false }, "maxMsgSpoolUsage": { - "description": "The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "description": "The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", "format": "int64", "maximum": 6000000, "minimum": 0, @@ -25448,7 +24718,7 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1500, + "x-configSyncDefault": 4000, "x-configSyncTableType": "vpn", "x-default": 5000, "x-deprecated": false, @@ -25463,7 +24733,7 @@ "x-writeOnly": false }, "maxRedeliveryCount": { - "description": "The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "description": "The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", "maximum": 255, "minimum": 0, @@ -25488,7 +24758,7 @@ "x-writeOnly": false }, "maxTtl": { - "description": "The maximum time in seconds a message can stay in the Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "description": "The maximum time in seconds a message can stay in a Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", "maximum": 4294967295, "minimum": 0, @@ -25533,96 +24803,24 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "owner": { - "description": "The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 189, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "egressEnabled" + "permission": { + "description": "The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", + "enum": [ + "no-access", + "read-only", + "consume", + "modify-topic", + "delete" ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "partitionCount": { - "description": "The count of partitions of the queue. Only relevant for queues with an access type of non-exclusive. When zero, bound clients receive messages round-robin. Otherwise, bound clients receive messages from individually assigned partitions. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.35.", - "format": "int32", - "maximum": 1000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "partitionRebalanceDelay": { - "description": "The delay (in seconds) before a partition rebalance is started once needed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`. Available since 2.35.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 5, - "x-configSyncTableType": "vpn", - "x-default": 5, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "partitionRebalanceMaxHandoffTime": { - "description": "The maximum time (in seconds) to wait before handing off a partition while rebalancing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. Available since 2.35.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 3, + "x-configSyncDefault": "no-access", "x-configSyncTableType": "vpn", - "x-default": 3, + "x-default": "no-access", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -25634,26 +24832,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "permission": { - "description": "The permission level for all consumers of the Queue, excluding the owner. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", - "enum": [ - "no-access", - "read-only", - "consume", - "modify-topic", - "delete" - ], + "queueNameFilter": { + "description": "A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 200, + "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], - "x-configSyncDefault": "no-access", + "x-autoDisable": [], + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": "no-access", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -25665,11 +24856,11 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "queueName": { - "description": "The name of the Queue.", - "maxLength": 200, + "queueTemplateName": { + "description": "The name of the Queue Template.", + "maxLength": 255, "minLength": 1, - "pattern": "^[^*?'<>&;]+$", + "pattern": "^[^#?*][^?*]*$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -25687,15 +24878,13 @@ "x-writeOnly": false }, "redeliveryDelayEnabled": { - "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", + "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": false, "x-configSyncTableType": "vpn", "x-default": false, @@ -25711,7 +24900,7 @@ "x-writeOnly": false }, "redeliveryDelayInitialInterval": { - "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", + "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", "format": "int32", "maximum": 3600000, "minimum": 1, @@ -25720,9 +24909,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": 1000, "x-configSyncTableType": "vpn", "x-default": 1000, @@ -25738,7 +24925,7 @@ "x-writeOnly": false }, "redeliveryDelayMaxInterval": { - "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", + "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", "format": "int32", "maximum": 10800000, "minimum": 1, @@ -25747,9 +24934,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": 64000, "x-configSyncTableType": "vpn", "x-default": 64000, @@ -25765,7 +24950,7 @@ "x-writeOnly": false }, "redeliveryDelayMultiplier": { - "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", + "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", "format": "int32", "maximum": 500, "minimum": 100, @@ -25774,9 +24959,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": 200, "x-configSyncTableType": "vpn", "x-default": 200, @@ -25836,7 +25019,7 @@ "x-writeOnly": false }, "rejectLowPriorityMsgLimit": { - "description": "The number of messages of any priority in the Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "description": "The number of messages of any priority above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", "maximum": 4294967295, "minimum": 0, @@ -25861,7 +25044,7 @@ "x-writeOnly": false }, "rejectMsgToSenderOnDiscardBehavior": { - "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as rejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-queue-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n Available since 2.1.", + "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-queue-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n", "enum": [ "never", "when-queue-enabled", @@ -25872,9 +25055,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "rejectLowPriorityMsgEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": "when-queue-enabled", "x-configSyncTableType": "vpn", "x-default": "when-queue-enabled", @@ -25890,16 +25071,13 @@ "x-writeOnly": false }, "respectMsgPriorityEnabled": { - "description": "Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). Regardless of this setting, message priority is not respected when browsing the queue, when the queue is used by a bridge, or if the queue is partitioned. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled and ingressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", + "description": "Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled", - "ingressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": false, "x-configSyncTableType": "vpn", "x-default": false, @@ -25915,7 +25093,7 @@ "x-writeOnly": false }, "respectTtlEnabled": { - "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -25944,7 +25122,7 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnQueueEventBindCountThreshold": { + "MsgVpnQueueTemplateEventBindCountThreshold": { "description": "The thresholds for the Queue consumer flows event, relative to `maxBindCount`.", "properties": { "clearPercent": { @@ -25982,7 +25160,7 @@ "clearValue": { "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 10000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -26044,7 +25222,7 @@ "setValue": { "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 10000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -26074,7 +25252,7 @@ }, "type": "object" }, - "MsgVpnQueueEventMsgSpoolUsageThreshold": { + "MsgVpnQueueTemplateEventMsgSpoolUsageThreshold": { "description": "The thresholds for the message spool usage event of the Queue, relative to `maxMsgSpoolUsage`.", "properties": { "clearPercent": { @@ -26112,7 +25290,7 @@ "clearValue": { "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 6000000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -26174,7 +25352,7 @@ "setValue": { "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 6000000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -26204,7 +25382,7 @@ }, "type": "object" }, - "MsgVpnQueueEventRejectLowPriorityMsgLimitThreshold": { + "MsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold": { "description": "The thresholds for the maximum allowed number of any priority messages queued in the Queue event, relative to `rejectLowPriorityMsgLimit`.", "properties": { "clearPercent": { @@ -26334,26 +25512,22 @@ }, "type": "object" }, - "MsgVpnQueueLinks": { + "MsgVpnQueueTemplateLinks": { "properties": { - "subscriptionsUri": { - "description": "The URI of this Queue's collection of Queue Subscription objects.", - "type": "string" - }, "uri": { - "description": "The URI of this Queue object.", + "description": "The URI of this Queue Template object.", "type": "string" } }, "type": "object" }, - "MsgVpnQueueResponse": { + "MsgVpnQueueTemplateResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnQueue" + "$ref": "#/definitions/MsgVpnQueueTemplate" }, "links": { - "$ref": "#/definitions/MsgVpnQueueLinks" + "$ref": "#/definitions/MsgVpnQueueTemplateLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -26364,94 +25538,19 @@ ], "type": "object" }, - "MsgVpnQueueSubscription": { - "properties": { - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "queueName": { - "description": "The name of the Queue.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "subscriptionTopic": { - "description": "The topic of the Subscription.", - "maxLength": 250, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnQueueSubscriptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Queue Subscription object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnQueueSubscriptionResponse": { + "MsgVpnQueueTemplatesResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnQueueSubscription" + "items": { + "$ref": "#/definitions/MsgVpnQueueTemplate" + }, + "type": "array" }, "links": { - "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" + "items": { + "$ref": "#/definitions/MsgVpnQueueTemplateLinks" + }, + "type": "array" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -26462,17 +25561,17 @@ ], "type": "object" }, - "MsgVpnQueueSubscriptionsResponse": { + "MsgVpnQueuesResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/MsgVpnQueueSubscription" + "$ref": "#/definitions/MsgVpnQueue" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" + "$ref": "#/definitions/MsgVpnQueueLinks" }, "type": "array" }, @@ -26485,45 +25584,19 @@ ], "type": "object" }, - "MsgVpnQueueTemplate": { + "MsgVpnReplayLog": { "properties": { - "accessType": { - "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n", - "enum": [ - "exclusive", - "non-exclusive" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "exclusive", - "x-configSyncTableType": "vpn", - "x-default": "exclusive", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "consumerAckPropagationEnabled": { - "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "egressEnabled": { + "description": "Enable or disable the transmission of messages from the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": true, + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": true, + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -26535,20 +25608,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "deadMsgQueue": { - "description": "The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", - "type": "string", + "ingressEnabled": { + "description": "Enable or disable the reception of messages to the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "#DEAD_MSG_QUEUE", + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": "#DEAD_MSG_QUEUE", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -26560,10 +25630,10 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "deliveryDelay": { - "description": "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. This attribute does not apply to MQTT queues created from this template, but it may apply in future releases. Therefore, to maintain forward compatibility, do not set this value on templates that might be used for MQTT queues. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", + "maxSpoolUsage": { + "description": "The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", - "maximum": 4294967295, + "maximum": 6000000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -26585,80 +25655,59 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "durabilityOverride": { - "description": "Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - The durability of the endpoint will be as requested on create.\n\"non-durable\" - The durability of the created queue will be non-durable, regardless of what was requested.\n
\n", - "enum": [ - "none", - "non-durable" - ], + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "none", - "x-configSyncTableType": "vpn", - "x-default": "none", "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "eventBindCountThreshold": { - "$ref": "#/definitions/MsgVpnQueueTemplateEventBindCountThreshold" - }, - "eventMsgSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnQueueTemplateEventMsgSpoolUsageThreshold" - }, - "eventRejectLowPriorityMsgLimitThreshold": { - "$ref": "#/definitions/MsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold" - }, - "maxBindCount": { - "description": "The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", - "format": "int64", - "maximum": 10000, - "minimum": 0, - "type": "integer", + "replayLogName": { + "description": "The name of the Replay Log.", + "maxLength": 185, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, - "x-configSyncTableType": "vpn", - "x-default": 1000, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "maxDeliveredUnackedMsgsPerFlow": { - "description": "The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", - "format": "int64", - "maximum": 1000000, - "minimum": 1, - "type": "integer", + "topicFilterEnabled": { + "description": "Enable or disable topic filtering for the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 10000, + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": 10000, + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -26669,107 +25718,191 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/read-write", + "post": "global/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnReplayLogLinks": { + "properties": { + "topicFilterSubscriptionsUri": { + "description": "The URI of this Replay Log's collection of Topic Filter Subscription objects. Available since 2.27.", + "type": "string" }, - "maxMsgSize": { - "description": "The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", - "format": "int32", - "maximum": 30000000, - "minimum": 0, - "type": "integer", + "uri": { + "description": "The URI of this Replay Log object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplayLogResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnReplayLog" + }, + "links": { + "$ref": "#/definitions/MsgVpnReplayLogLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplayLogTopicFilterSubscription": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 10000000, - "x-configSyncTableType": "vpn", - "x-default": 10000000, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "maxMsgSpoolUsage": { - "description": "The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", + "replayLogName": { + "description": "The name of the Replay Log.", + "maxLength": 185, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 1500, - "x-configSyncTableType": "vpn", - "x-default": 5000, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "maxRedeliveryCount": { - "description": "The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 255, - "minimum": 0, - "type": "integer", + "topicFilterSubscription": { + "description": "The topic of the Subscription.", + "maxLength": 250, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnReplayLogTopicFilterSubscriptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Topic Filter Subscription object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplayLogTopicFilterSubscriptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" }, - "maxTtl": { - "description": "The maximum time in seconds a message can stay in a Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "links": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplayLogTopicFilterSubscriptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplayLogsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLog" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLogLinks" + }, + "type": "array" }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplicatedTopic": { + "properties": { "msgVpnName": { "description": "The name of the Message VPN.", "maxLength": 32, @@ -26791,48 +25924,41 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "permission": { - "description": "The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", - "enum": [ - "no-access", - "read-only", - "consume", - "modify-topic", - "delete" - ], + "replicatedTopic": { + "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", + "maxLength": 250, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "no-access", - "x-configSyncTableType": "vpn", - "x-default": "no-access", "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "queueNameFilter": { - "description": "A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, + "replicationMode": { + "description": "The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are:\n\n
\n\"sync\" - Messages are acknowledged when replicated (spooled remotely).\n\"async\" - Messages are acknowledged when pending replication (spooled locally).\n
\n", + "enum": [ + "sync", + "async" + ], "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "", + "x-configSyncDefault": "async", "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": "async", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -26843,30 +25969,112 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnReplicatedTopicLinks": { + "properties": { + "uri": { + "description": "The URI of this Replicated Topic object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplicatedTopicResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnReplicatedTopic" }, - "queueTemplateName": { - "description": "The name of the Queue Template.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[^#?*][^?*]*$", - "type": "string", + "links": { + "$ref": "#/definitions/MsgVpnReplicatedTopicLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplicatedTopicsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnReplicatedTopic" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnReplicatedTopicLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpn" + }, + "links": { + "$ref": "#/definitions/MsgVpnLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPoint": { + "properties": { + "clientProfileName": { + "description": "The Client Profile of the REST Delivery Point. It must exist in the local Message VPN. Its TCP parameters are used for all REST Consumers in this RDP. Its queue properties are used by the RDP client. The Client Profile is used inside the auto-generated Client Username for this RDP. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "maxLength": 32, + "minLength": 1, + "pattern": "^#?[A-Za-z0-9\\-_]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "default", + "x-configSyncTableType": "vpn", + "x-default": "default", "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayEnabled": { - "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", + "enabled": { + "description": "Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -26887,70 +26095,60 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayInitialInterval": { - "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", - "format": "int32", - "maximum": 3600000, - "minimum": 1, - "type": "integer", + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, - "x-configSyncTableType": "vpn", - "x-default": 1000, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayMaxInterval": { - "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", - "format": "int32", - "maximum": 10800000, - "minimum": 1, - "type": "integer", + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "maxLength": 100, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 64000, - "x-configSyncTableType": "vpn", - "x-default": 64000, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayMultiplier": { - "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", - "format": "int32", - "maximum": 500, - "minimum": 100, - "type": "integer", + "service": { + "description": "The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "maxLength": 50, + "minLength": 0, + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 200, + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": 200, + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -26962,17 +26160,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryEnabled": { - "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", - "type": "boolean", + "vendor": { + "description": "The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "maxLength": 50, + "minLength": 0, + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": true, + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": true, + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -26983,9 +26183,36 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnRestDeliveryPointLinks": { + "properties": { + "queueBindingsUri": { + "description": "The URI of this REST Delivery Point's collection of Queue Binding objects.", + "type": "string" }, - "rejectLowPriorityMsgEnabled": { - "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "restConsumersUri": { + "description": "The URI of this REST Delivery Point's collection of REST Consumer objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this REST Delivery Point object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBinding": { + "properties": { + "gatewayReplaceTargetAuthorityEnabled": { + "description": "Enable or disable whether the authority for the request-target is replaced with that configured for the REST Consumer remote. When enabled, the broker sends HTTP requests in absolute-form, with the request-target's authority taken from the REST Consumer's remote host and port configuration. When disabled, the broker sends HTTP requests whose request-target matches that of the original request message, including whether to use absolute-form or origin-form. This configuration is applicable only when the Message VPN is in REST gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -27006,47 +26233,40 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "rejectLowPriorityMsgLimit": { - "description": "The number of messages of any priority above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "rejectMsgToSenderOnDiscardBehavior": { - "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-queue-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n", - "enum": [ - "never", - "when-queue-enabled", - "always" - ], + "postRequestTarget": { + "description": "The request-target string to use when sending requests. It identifies the target resource on the far-end REST Consumer upon which to apply the request. There are generally two common forms for the request-target. The origin-form is most often used in practice and contains the path and query components of the target URI. If the path component is empty then the client must generally send a \"/\" as the path. When making a request to a proxy, most often the absolute-form is required. This configuration is only applicable when the Message VPN is in REST messaging mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 2000, + "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "when-queue-enabled", + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": "when-queue-enabled", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -27058,17 +26278,42 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "respectMsgPriorityEnabled": { - "description": "Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "queueBindingName": { + "description": "The name of a queue in the Message VPN.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only" + }, + "x-autoDisable": [], + "x-deprecated": false, + "x-identifying": true, + "x-identifyingDirect": true, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": true, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "requestTargetEvaluation": { + "description": "The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Do not evaluate substitution expressions on the request target.\n\"substitution-expressions\" - Evaluate substitution expressions on the request target.\n
\n Available since 2.23.", + "enum": [ + "none", + "substitution-expressions" + ], + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": false, + "x-configSyncDefault": "none", "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -27080,23 +26325,21 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "respectTtlEnabled": { - "description": "Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "maxLength": 100, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], @@ -27110,435 +26353,155 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnQueueTemplateEventBindCountThreshold": { - "description": "The thresholds for the Queue consumer flows event, relative to `maxBindCount`.", + "MsgVpnRestDeliveryPointQueueBindingLinks": { "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false + "protectedRequestHeadersUri": { + "description": "The URI of this Queue Binding's collection of Protected Request Header objects. Available since 2.30.", + "type": "string" }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 10000, - "minimum": 0, - "type": "integer", + "requestHeadersUri": { + "description": "The URI of this Queue Binding's collection of Request Header objects. Available since 2.23.", + "type": "string" + }, + "uri": { + "description": "The URI of this Queue Binding object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader": { + "properties": { + "headerName": { + "description": "The name of the protected HTTP request header.", + "maxLength": 50, + "minLength": 1, + "pattern": "^[A-Za-z0-9!#$%&'*+\\-.\\^_`|~]*$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setValue" - ], + "x-readOptional": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + "headerValue": { + "description": "The value of the protected HTTP request header. Unlike a non-protected request header, this value cannot be displayed after it is set, and does not support substitution expressions. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 2000, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 80, + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": false, + "x-opaque": true, "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": true, "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 10000, - "minimum": 0, - "type": "integer", + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnQueueTemplateEventMsgSpoolUsageThreshold": { - "description": "The thresholds for the message spool usage event of the Queue, relative to `maxMsgSpoolUsage`.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + }, + "queueBindingName": { + "description": "The name of a queue in the Message VPN.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 18, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "maxLength": 100, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 25, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], "x-requiresDisable": [], "x-writeOnly": false } }, - "type": "object" - }, - "MsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold": { - "description": "The thresholds for the maximum allowed number of any priority messages queued in the Queue event, relative to `rejectLowPriorityMsgLimit`.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" }, - "type": "object" + "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnQueueTemplateLinks": { + "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks": { "properties": { "uri": { - "description": "The URI of this Queue Template object.", + "description": "The URI of this Protected Request Header object.", "type": "string" } }, "type": "object" }, - "MsgVpnQueueTemplateResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnQueueTemplate" - }, - "links": { - "$ref": "#/definitions/MsgVpnQueueTemplateLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnQueueTemplatesResponse": { + "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse": { "properties": { "data": { - "items": { - "$ref": "#/definitions/MsgVpnQueueTemplate" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader" }, "links": { - "items": { - "$ref": "#/definitions/MsgVpnQueueTemplateLinks" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -27549,17 +26512,17 @@ ], "type": "object" }, - "MsgVpnQueuesResponse": { + "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/MsgVpnQueue" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/MsgVpnQueueLinks" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks" }, "type": "array" }, @@ -27572,66 +26535,42 @@ ], "type": "object" }, - "MsgVpnReplayLog": { + "MsgVpnRestDeliveryPointQueueBindingRequestHeader": { "properties": { - "egressEnabled": { - "description": "Enable or disable the transmission of messages from the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "ingressEnabled": { - "description": "Enable or disable the reception of messages to the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "headerName": { + "description": "The name of the HTTP request header.", + "maxLength": 50, + "minLength": 1, + "pattern": "^[A-Za-z0-9!#$%&'*+\\-.\\^_`|~]*$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "maxSpoolUsage": { - "description": "The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", + "headerValue": { + "description": "A substitution expression for the value of the HTTP request header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 2000, + "minLength": 0, + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 0, + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": 0, + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -27664,9 +26603,9 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "replayLogName": { - "description": "The name of the Replay Log.", - "maxLength": 185, + "queueBindingName": { + "description": "The name of a queue in the Message VPN.", + "maxLength": 200, "minLength": 1, "pattern": "^[^*?'<>&;]+$", "type": "string", @@ -27676,32 +26615,30 @@ "x-autoDisable": [], "x-deprecated": false, "x-identifying": true, - "x-identifyingDirect": true, + "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": true, - "x-readOnlyPost": false, + "x-readOnlyPost": true, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "topicFilterEnabled": { - "description": "Enable or disable topic filtering for the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27.", - "type": "boolean", + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "maxLength": 100, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], @@ -27710,31 +26647,27 @@ }, "type": "object", "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" + "delete": "vpn/read-write", + "post": "vpn/read-write" }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnReplayLogLinks": { + "MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks": { "properties": { - "topicFilterSubscriptionsUri": { - "description": "The URI of this Replay Log's collection of Topic Filter Subscription objects. Available since 2.27.", - "type": "string" - }, "uri": { - "description": "The URI of this Replay Log object.", + "description": "The URI of this Request Header object.", "type": "string" } }, "type": "object" }, - "MsgVpnReplayLogResponse": { + "MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnReplayLog" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" }, "links": { - "$ref": "#/definitions/MsgVpnReplayLogLinks" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -27745,94 +26678,36 @@ ], "type": "object" }, - "MsgVpnReplayLogTopicFilterSubscription": { + "MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse": { "properties": { - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "replayLogName": { - "description": "The name of the Replay Log.", - "maxLength": 185, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks" }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "topicFilterSubscription": { - "description": "The topic of the Subscription.", - "maxLength": 250, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnReplayLogTopicFilterSubscriptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Topic Filter Subscription object.", - "type": "string" + "meta": { + "$ref": "#/definitions/SempMeta" } }, + "required": [ + "meta" + ], "type": "object" }, - "MsgVpnReplayLogTopicFilterSubscriptionResponse": { + "MsgVpnRestDeliveryPointQueueBindingResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" }, "links": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionLinks" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -27843,17 +26718,17 @@ ], "type": "object" }, - "MsgVpnReplayLogTopicFilterSubscriptionsResponse": { + "MsgVpnRestDeliveryPointQueueBindingsResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionLinks" + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingLinks" }, "type": "array" }, @@ -27866,19 +26741,13 @@ ], "type": "object" }, - "MsgVpnReplayLogsResponse": { + "MsgVpnRestDeliveryPointResponse": { "properties": { "data": { - "items": { - "$ref": "#/definitions/MsgVpnReplayLog" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnRestDeliveryPoint" }, "links": { - "items": { - "$ref": "#/definitions/MsgVpnReplayLogLinks" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnRestDeliveryPointLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -27889,167 +26758,92 @@ ], "type": "object" }, - "MsgVpnReplicatedTopic": { + "MsgVpnRestDeliveryPointRestConsumer": { "properties": { - "msgVpnName": { - "description": "The name of the Message VPN.", + "authenticationAwsAccessKeyId": { + "description": "The AWS access key id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "replicatedTopic": { - "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", - "maxLength": 250, - "minLength": 1, + "authenticationAwsRegion": { + "description": "The AWS region id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "maxLength": 20, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "replicationMode": { - "description": "The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are:\n\n
\n\"sync\" - Messages are acknowledged when replicated (spooled remotely).\n\"async\" - Messages are acknowledged when pending replication (spooled locally).\n
\n", - "enum": [ - "sync", - "async" - ], + "authenticationAwsSecretAccessKey": { + "description": "The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "maxLength": 64, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "async", + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": "async", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": false, + "x-opaque": true, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnReplicatedTopicLinks": { - "properties": { - "uri": { - "description": "The URI of this Replicated Topic object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnReplicatedTopicResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnReplicatedTopic" - }, - "links": { - "$ref": "#/definitions/MsgVpnReplicatedTopicLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnReplicatedTopicsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnReplicatedTopic" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnReplicatedTopicLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpn" - }, - "links": { - "$ref": "#/definitions/MsgVpnLinks" + "x-writeOnly": true }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPoint": { - "properties": { - "clientProfileName": { - "description": "The Client Profile of the REST Delivery Point. It must exist in the local Message VPN. Its TCP parameters are used for all REST Consumers in this RDP. Its queue properties are used by the RDP client. The Client Profile is used inside the auto-generated Client Username for this RDP. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", - "maxLength": 32, - "minLength": 1, - "pattern": "^#?[A-Za-z0-9\\-_]+$", + "authenticationAwsService": { + "description": "The AWS service id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "maxLength": 50, + "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "default", + "x-autoDisable": [], + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": "default", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -28061,79 +26855,97 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "enabled": { - "description": "Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "authenticationClientCertContent": { + "description": "The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`. Available since 2.9.", + "maxLength": 32768, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": false, + "x-opaque": true, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", + "authenticationClientCertPassword": { + "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`. Available since 2.9.", + "maxLength": 512, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-default": "", "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "authenticationClientCertContent" + ], "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "minLength": 1, + "authenticationHttpBasicPassword": { + "description": "The password for the username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 128, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "authenticationHttpBasicUsername" + ], "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "service": { - "description": "The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", - "maxLength": 50, + "authenticationHttpBasicUsername": { + "description": "The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected for the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 189, "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], "x-configSyncDefault": "", "x-configSyncTableType": "vpn", "x-default": "", @@ -28145,13 +26957,17 @@ "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, + "x-requires": [ + "authenticationHttpBasicPassword" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "vendor": { - "description": "The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "authenticationHttpHeaderName": { + "description": "The authentication header name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", "maxLength": 50, "minLength": 0, + "pattern": "^[A-Za-z0-9!#$%&'*+\\-.\\^_`|~]*$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", @@ -28171,87 +26987,69 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnRestDeliveryPointLinks": { - "properties": { - "queueBindingsUri": { - "description": "The URI of this REST Delivery Point's collection of Queue Binding objects.", - "type": "string" - }, - "restConsumersUri": { - "description": "The URI of this REST Delivery Point's collection of REST Consumer objects.", - "type": "string" }, - "uri": { - "description": "The URI of this REST Delivery Point object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBinding": { - "properties": { - "gatewayReplaceTargetAuthorityEnabled": { - "description": "Enable or disable whether the authority for the request-target is replaced with that configured for the REST Consumer remote. When enabled, the broker sends HTTP requests in absolute-form, with the request-target's authority taken from the REST Consumer's remote host and port configuration. When disabled, the broker sends HTTP requests whose request-target matches that of the original request message, including whether to use absolute-form or origin-form. This configuration is applicable only when the Message VPN is in REST gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.6.", - "type": "boolean", + "authenticationHttpHeaderValue": { + "description": "The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", + "maxLength": 2100, + "minLength": 0, + "pattern": "^[ -~\\t]*$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": false, + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": false, + "x-opaque": true, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", + "authenticationOauthClientId": { + "description": "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "maxLength": 200, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "postRequestTarget": { - "description": "The request-target string to use when sending requests. It identifies the target resource on the far-end REST Consumer upon which to apply the request. There are generally two common forms for the request-target. The origin-form is most often used in practice and contains the path and query components of the target URI. If the path component is empty then the client must generally send a \"/\" as the path. When making a request to a proxy, most often the absolute-form is required. This configuration is only applicable when the Message VPN is in REST messaging mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 2000, + "authenticationOauthClientScope": { + "description": "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "maxLength": 200, "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], "x-configSyncDefault": "", "x-configSyncTableType": "vpn", "x-default": "", @@ -28266,42 +27064,46 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "queueBindingName": { - "description": "The name of a queue in the Message VPN.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", + "authenticationOauthClientSecret": { + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "maxLength": 512, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "requestTargetEvaluation": { - "description": "The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Do not evaluate substitution expressions on the request target.\n\"substitution-expressions\" - Evaluate substitution expressions on the request target.\n
\n Available since 2.23.", - "enum": [ - "none", - "substitution-expressions" - ], + "authenticationOauthClientTokenEndpoint": { + "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "maxLength": 2048, + "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], - "x-configSyncDefault": "none", + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": "none", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -28313,242 +27115,196 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "minLength": 1, - "type": "string", + "authenticationOauthClientTokenExpiryDefault": { + "description": "The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `900`. Available since 2.30.", + "format": "int32", + "maximum": 86400, + "minimum": 60, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": 900, + "x-configSyncTableType": "vpn", + "x-default": 900, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnRestDeliveryPointQueueBindingLinks": { - "properties": { - "protectedRequestHeadersUri": { - "description": "The URI of this Queue Binding's collection of Protected Request Header objects. Available since 2.30.", - "type": "string" - }, - "requestHeadersUri": { - "description": "The URI of this Queue Binding's collection of Request Header objects. Available since 2.23.", - "type": "string" }, - "uri": { - "description": "The URI of this Queue Binding object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader": { - "properties": { - "headerName": { - "description": "The name of the protected HTTP request header.", - "maxLength": 50, - "minLength": 1, - "pattern": "^[A-Za-z0-9!#$%&'*+\\-.\\^_`|~]*$", + "authenticationOauthJwtSecretKey": { + "description": "The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21.", + "maxLength": 4096, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "headerValue": { - "description": "The value of the protected HTTP request header. Unlike a non-protected request header, this value cannot be displayed after it is set, and does not support substitution expressions. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 2000, + "authenticationOauthJwtTokenEndpoint": { + "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21.", + "maxLength": 2048, "minLength": 0, "type": "string", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], "x-configSyncDefault": "", "x-configSyncTableType": "vpn", "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": true, + "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "authenticationOauthJwtTokenExpiryDefault": { + "description": "The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `900`. Available since 2.30.", + "format": "int32", + "maximum": 86400, + "minimum": 60, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": 900, + "x-configSyncTableType": "vpn", + "x-default": 900, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "queueBindingName": { - "description": "The name of a queue in the Message VPN.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", + "authenticationScheme": { + "description": "The authentication scheme used by the REST Consumer to login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication.\n\"http-basic\" - Login with a username and optional password according to HTTP Basic authentication as per RFC 2616.\n\"client-certificate\" - Login with a client TLS certificate as per RFC 5246. Client certificate authentication is only available on TLS connections.\n\"http-header\" - Login with a specified HTTP header.\n\"oauth-client\" - Login with OAuth 2.0 client credentials.\n\"oauth-jwt\" - Login with OAuth (RFC 7523 JWT Profile).\n\"transparent\" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header.\n\"aws\" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256).\n
\n", + "enum": [ + "none", + "http-basic", + "client-certificate", + "http-header", + "oauth-client", + "oauth-jwt", + "transparent", + "aws" + ], "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "none", + "x-configSyncTableType": "vpn", + "x-default": "none", "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "minLength": 1, - "type": "string", + "enabled": { + "description": "Enable or disable the REST Consumer. When disabled, no connections are initiated or messages delivered to this particular REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks": { - "properties": { - "uri": { - "description": "The URI of this Protected Request Header object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader" - }, - "links": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderLinks" - }, - "type": "array" }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingRequestHeader": { - "properties": { - "headerName": { - "description": "The name of the HTTP request header.", - "maxLength": 50, - "minLength": 1, - "pattern": "^[A-Za-z0-9!#$%&'*+\\-.\\^_`|~]*$", + "httpMethod": { + "description": "The HTTP method to use (POST or PUT). This is used only when operating in the REST service \"messaging\" mode and is ignored in \"gateway\" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"post\"`. The allowed values and their meaning are:\n\n
\n\"post\" - Use the POST HTTP method.\n\"put\" - Use the PUT HTTP method.\n
\n Available since 2.17.", + "enum": [ + "post", + "put" + ], "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": "post", + "x-configSyncTableType": "vpn", + "x-default": "post", "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "headerValue": { - "description": "A substitution expression for the value of the HTTP request header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 2000, + "localInterface": { + "description": "The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 15, "minLength": 0, "type": "string", "x-accessLevels": { @@ -28570,32 +27326,36 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "maxPostWaitTime": { + "description": "The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`.", + "format": "int32", + "maximum": 300, + "minimum": 1, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 30, + "x-configSyncTableType": "vpn", + "x-default": 30, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "queueBindingName": { - "description": "The name of a queue in the Message VPN.", - "maxLength": 200, + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, "minLength": 1, - "pattern": "^[^*?'<>&;]+$", + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -28612,144 +27372,35 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "minLength": 1, - "type": "string", + "outgoingConnectionCount": { + "description": "The number of concurrent TCP connections open to the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int32", + "maximum": 50, + "minimum": 1, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": 3, + "x-configSyncTableType": "vpn", + "x-default": 3, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks": { - "properties": { - "uri": { - "description": "The URI of this Request Header object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" - }, - "links": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" - }, - "links": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointQueueBindingsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnRestDeliveryPoint" - }, - "links": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointLinks" }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointRestConsumer": { - "properties": { - "authenticationAwsAccessKeyId": { - "description": "The AWS access key id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "proxyName": { + "description": "The name of the proxy to use. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.36.", "maxLength": 32, "minLength": 0, "type": "string", @@ -28772,16 +27423,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationAwsRegion": { - "description": "The AWS region id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", - "maxLength": 20, + "remoteHost": { + "description": "The IP address or DNS name to which the broker is to connect to deliver messages for the REST Consumer. A host value must be configured for the REST Consumer to be operationally up. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 253, "minLength": 0, + "pattern": "^([0-9a-zA-Z_\\-\\.]*|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,7}:|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|:((:[0-9a-fA-F]{1,4}){1,7}|:)|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], + "x-autoDisable": [ + "enabled" + ], "x-configSyncDefault": "", "x-configSyncTableType": "vpn", "x-default": "", @@ -28796,137 +27450,130 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationAwsSecretAccessKey": { - "description": "The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", - "maxLength": 64, - "minLength": 0, - "type": "string", + "remotePort": { + "description": "The port associated with the host of the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8080`.", + "format": "int64", + "maximum": 65535, + "minimum": 1, + "type": "integer", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [], - "x-configSyncDefault": "", + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": 8080, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 8080, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": true, + "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, + "x-requires": [ + "tlsEnabled" + ], "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationAwsService": { - "description": "The AWS service id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", - "maxLength": 50, - "minLength": 0, + "restConsumerName": { + "description": "The name of the REST Consumer.", + "maxLength": 32, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`. Available since 2.9.", - "maxLength": 32768, - "minLength": 0, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "maxLength": 100, + "minLength": 1, "type": "string", "x-accessLevels": { - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationClientCertPassword": { - "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`. Available since 2.9.", - "maxLength": 512, - "minLength": 0, - "type": "string", + "retryDelay": { + "description": "The number of seconds that must pass before retrying the remote REST Consumer connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int32", + "maximum": 300, + "minimum": 1, + "type": "integer", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", + "x-autoDisable": [], + "x-configSyncDefault": 3, + "x-configSyncTableType": "vpn", + "x-default": 3, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "authenticationClientCertContent" - ], "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationHttpBasicPassword": { - "description": "The password for the username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 128, + "tlsCipherSuiteList": { + "description": "The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection. The value `\"default\"` implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the `tlsCipherSuiteMsgBackboneDefaultList` attribute of the Broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "maxLength": 1559, "minLength": 0, "type": "string", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ "enabled" ], - "x-configSyncDefault": "", + "x-configSyncDefault": "default", "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": "default", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": true, + "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "authenticationHttpBasicUsername" - ], "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationHttpBasicUsername": { - "description": "The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected for the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 189, - "minLength": 0, - "type": "string", + "tlsEnabled": { + "description": "Enable or disable encryption (TLS) for the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" @@ -28934,9 +27581,9 @@ "x-autoDisable": [ "enabled" ], - "x-configSyncDefault": "", + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -28946,399 +27593,401 @@ "x-readOptional": false, "x-requiredPost": false, "x-requires": [ - "authenticationHttpBasicPassword" + "remotePort" ], "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnRestDeliveryPointRestConsumerLinks": { + "properties": { + "oauthJwtClaimsUri": { + "description": "The URI of this REST Consumer's collection of Claim objects. Available since 2.21.", + "type": "string" }, - "authenticationHttpHeaderName": { - "description": "The authentication header name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", - "maxLength": 50, - "minLength": 0, - "pattern": "^[A-Za-z0-9!#$%&'*+\\-.\\^_`|~]*$", + "tlsTrustedCommonNamesUri": { + "description": "The URI of this REST Consumer's collection of Trusted Common Name objects. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "uri": { + "description": "The URI of this REST Consumer object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationHttpHeaderValue": { - "description": "The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", - "maxLength": 2100, - "minLength": 0, - "pattern": "^[ -~\\t]*$", + "oauthJwtClaimName": { + "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", + "maxLength": 100, + "minLength": 1, "type": "string", "x-accessLevels": { - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, + "x-identifying": true, + "x-identifyingDirect": true, + "x-opaque": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, + "x-readOptional": false, + "x-requiredPost": true, "x-requiresDisable": [], - "x-writeOnly": true + "x-writeOnly": false }, - "authenticationOauthClientId": { - "description": "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "oauthJwtClaimValue": { + "description": "The value of the additional claim, which must be a string containing a valid JSON value.", "maxLength": 200, - "minLength": 0, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationOauthClientScope": { - "description": "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", - "maxLength": 200, - "minLength": 0, + "restConsumerName": { + "description": "The name of the REST Consumer.", + "maxLength": 32, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "authenticationOauthClientSecret": { - "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", - "maxLength": 512, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true - }, - "authenticationOauthClientTokenEndpoint": { - "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", - "maxLength": 2048, - "minLength": 0, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "maxLength": 100, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks": { + "properties": { + "uri": { + "description": "The URI of this Claim object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" }, - "authenticationOauthClientTokenExpiryDefault": { - "description": "The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `900`. Available since 2.30.", - "format": "int32", - "maximum": 86400, - "minimum": 60, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 900, - "x-configSyncTableType": "vpn", - "x-default": 900, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks" }, - "authenticationOauthJwtSecretKey": { - "description": "The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21.", - "maxLength": 4096, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true + "type": "array" }, - "authenticationOauthJwtTokenEndpoint": { - "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21.", - "maxLength": 2048, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "authenticationOauthJwtTokenExpiryDefault": { - "description": "The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `900`. Available since 2.30.", - "format": "int32", - "maximum": 86400, - "minimum": 60, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 900, - "x-configSyncTableType": "vpn", - "x-default": 900, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" }, - "authenticationScheme": { - "description": "The authentication scheme used by the REST Consumer to login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication.\n\"http-basic\" - Login with a username and optional password according to HTTP Basic authentication as per RFC 2616.\n\"client-certificate\" - Login with a client TLS certificate as per RFC 5246. Client certificate authentication is only available on TLS connections.\n\"http-header\" - Login with a specified HTTP header.\n\"oauth-client\" - Login with OAuth 2.0 client credentials.\n\"oauth-jwt\" - Login with OAuth (RFC 7523 JWT Profile).\n\"transparent\" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header.\n\"aws\" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256).\n
\n", - "enum": [ - "none", - "http-basic", - "client-certificate", - "http-header", - "oauth-client", - "oauth-jwt", - "transparent", - "aws" - ], + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "none", - "x-configSyncTableType": "vpn", - "x-default": "none", - "x-deprecated": false, - "x-identifying": false, + "x-autoDisable": [], + "x-deprecated": true, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "enabled": { - "description": "Enable or disable the REST Consumer. When disabled, no connections are initiated or messages delivered to this particular REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "restConsumerName": { + "description": "The name of the REST Consumer. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "maxLength": 32, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, + "x-deprecated": true, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "httpMethod": { - "description": "The HTTP method to use (POST or PUT). This is used only when operating in the REST service \"messaging\" mode and is ignored in \"gateway\" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"post\"`. The allowed values and their meaning are:\n\n
\n\"post\" - Use the POST HTTP method.\n\"put\" - Use the PUT HTTP method.\n
\n Available since 2.17.", - "enum": [ - "post", - "put" - ], + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "maxLength": 100, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "post", - "x-configSyncTableType": "vpn", - "x-default": "post", - "x-deprecated": false, - "x-identifying": false, + "x-deprecated": true, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "localInterface": { - "description": "The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 15, - "minLength": 0, + "tlsTrustedCommonName": { + "description": "The expected trusted common name of the remote certificate. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "maxLength": 64, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-deprecated": true, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks": { + "properties": { + "uri": { + "description": "The URI of this Trusted Common Name object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" }, - "maxPostWaitTime": { - "description": "The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`.", - "format": "int32", - "maximum": 300, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" }, - "x-autoDisable": [], - "x-configSyncDefault": 30, - "x-configSyncTableType": "vpn", - "x-default": 30, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPoint" + }, + "type": "array" }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnSequencedTopic": { + "properties": { "msgVpnName": { "description": "The name of the Message VPN.", "maxLength": 32, @@ -29360,73 +28009,126 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "outgoingConnectionCount": { - "description": "The number of concurrent TCP connections open to the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int32", - "maximum": 50, - "minimum": 1, - "type": "integer", + "sequencedTopic": { + "description": "Topic for applying sequence numbers.", + "maxLength": 250, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 3, - "x-configSyncTableType": "vpn", - "x-default": 3, + "x-autoDisable": [], "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false - }, - "proxyName": { - "description": "The name of the proxy to use. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.36.", - "maxLength": 32, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnSequencedTopicLinks": { + "properties": { + "uri": { + "description": "The URI of this Sequenced Topic object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnSequencedTopicResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnSequencedTopic" + }, + "links": { + "$ref": "#/definitions/MsgVpnSequencedTopicLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnSequencedTopicsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnSequencedTopic" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnSequencedTopicLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTelemetryProfile": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only" + }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "remoteHost": { - "description": "The IP address or DNS name to which the broker is to connect to deliver messages for the REST Consumer. A host value must be configured for the REST Consumer to be operationally up. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 253, - "minLength": 0, - "pattern": "^([0-9a-zA-Z_\\-\\.]*|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,7}:|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|:((:[0-9a-fA-F]{1,4}){1,7}|:)|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])$", - "type": "string", + "queueEventBindCountThreshold": { + "$ref": "#/definitions/MsgVpnTelemetryProfileQueueEventBindCountThreshold" + }, + "queueEventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/MsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold" + }, + "queueMaxBindCount": { + "description": "The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "maximum": 10000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", + "x-autoDisable": [], + "x-configSyncDefault": 1000, "x-configSyncTableType": "vpn", - "x-default": "", + "x-default": 1000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -29438,22 +28140,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "remotePort": { - "description": "The port associated with the host of the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8080`.", + "queueMaxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed by the Queue, in megabytes (MB). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `800000`.", "format": "int64", - "maximum": 65535, + "maximum": 6000000, "minimum": 1, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 8080, + "x-autoDisable": [], + "x-configSyncDefault": 800000, "x-configSyncTableType": "vpn", - "x-default": 8080, + "x-default": 800000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -29462,66 +28162,72 @@ "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "tlsEnabled" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "restConsumerName": { - "description": "The name of the REST Consumer.", - "maxLength": 32, - "minLength": 1, + "receiverAclConnectDefaultAction": { + "description": "The default action to take when a receiver client connects to the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are:\n\n
\n\"allow\" - Allow client connection unless an exception is found for it.\n\"disallow\" - Disallow client connection unless an exception is found for it.\n
\n", + "enum": [ + "allow", + "disallow" + ], "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": "disallow", + "x-configSyncTableType": "vpn", + "x-default": "disallow", "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "minLength": 1, - "type": "string", + "receiverEnabled": { + "description": "Enable or disable the ability for receiver clients to consume from the #telemetry queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "retryDelay": { - "description": "The number of seconds that must pass before retrying the remote REST Consumer connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int32", - "maximum": 300, - "minimum": 1, + "receiverEventConnectionCountPerClientUsernameThreshold": { + "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold" + }, + "receiverMaxConnectionCountPerClientUsername": { + "description": "The maximum number of receiver connections per Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", + "format": "int64", + "maximum": 200000, + "minimum": 0, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 3, "x-configSyncTableType": "vpn", - "x-default": 3, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -29533,21 +28239,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "tlsCipherSuiteList": { - "description": "The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection. The value `\"default\"` implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the `tlsCipherSuiteMsgBackboneDefaultList` attribute of the Broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", - "maxLength": 1559, - "minLength": 0, - "type": "string", + "receiverTcpCongestionWindowSize": { + "description": "The TCP initial congestion window size for clients using the Client Profile, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2`.", + "format": "int64", + "maximum": 7826, + "minimum": 2, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "default", + "x-autoDisable": [], + "x-configSyncDefault": 2, "x-configSyncTableType": "vpn", - "x-default": "default", + "x-default": 2, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -29559,19 +28264,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "tlsEnabled": { - "description": "Enable or disable encryption (TLS) for the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "receiverTcpKeepaliveCount": { + "description": "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", + "format": "int64", + "maximum": 5, + "minimum": 2, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": false, + "x-autoDisable": [], + "x-configSyncDefault": 5, "x-configSyncTableType": "vpn", - "x-default": false, + "x-default": 5, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -29580,104 +28286,114 @@ "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "remotePort" - ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnRestDeliveryPointRestConsumerLinks": { - "properties": { - "oauthJwtClaimsUri": { - "description": "The URI of this REST Consumer's collection of Claim objects. Available since 2.21.", - "type": "string" }, - "tlsTrustedCommonNamesUri": { - "description": "The URI of this REST Consumer's collection of Trusted Common Name objects. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", - "type": "string" + "receiverTcpKeepaliveIdleTime": { + "description": "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int64", + "maximum": 120, + "minimum": 3, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 3, + "x-configSyncTableType": "vpn", + "x-default": 3, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false }, - "uri": { - "description": "The URI of this REST Consumer object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim": { - "properties": { - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "receiverTcpKeepaliveInterval": { + "description": "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgment is received, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int64", + "maximum": 30, + "minimum": 1, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 1, + "x-configSyncTableType": "vpn", + "x-default": 1, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "oauthJwtClaimName": { - "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", - "maxLength": 100, - "minLength": 1, - "type": "string", + "receiverTcpMaxSegmentSize": { + "description": "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1460`.", + "format": "int64", + "maximum": 1460, + "minimum": 256, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 1460, + "x-configSyncTableType": "vpn", + "x-default": 1460, "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "oauthJwtClaimValue": { - "description": "The value of the additional claim, which must be a string containing a valid JSON value.", - "maxLength": 200, - "minLength": 1, - "type": "string", + "receiverTcpMaxWindowSize": { + "description": "The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. This setting is ignored on the software broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`.", + "format": "int64", + "maximum": 65536, + "minimum": 16, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 256, + "x-configSyncTableType": "vpn", + "x-default": 256, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "restConsumerName": { - "description": "The name of the REST Consumer.", - "maxLength": 32, + "telemetryProfileName": { + "description": "The name of the Telemetry Profile.", + "maxLength": 21, "minLength": 1, + "pattern": "^[A-Za-z0-9\\-_]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -29685,30 +28401,54 @@ "x-autoDisable": [], "x-deprecated": false, "x-identifying": true, - "x-identifyingDirect": false, + "x-identifyingDirect": true, "x-opaque": false, "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": true, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "traceEnabled": { + "description": "Enable or disable generation of all trace span data messages. When enabled, the state of configured trace filters control which messages get traced. When disabled, trace span data messages are never generated, regardless of the state of trace filters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "minLength": 1, - "type": "string", + "traceSendSpanGenerationEnabled": { + "description": "Enable or disable generation of send spans. For the most complete view of broker message processing, this should be enabled. If the information provided by send spans are not needed, send spans can be disabled to reduce the performance impact of tracing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.36.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": true, + "x-configSyncTableType": "vpn", + "x-default": true, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], @@ -29722,259 +28462,284 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks": { + "MsgVpnTelemetryProfileLinks": { "properties": { - "uri": { - "description": "The URI of this Claim object.", + "receiverAclConnectExceptionsUri": { + "description": "The URI of this Telemetry Profile's collection of Receiver ACL Connect Exception objects.", "type": "string" - } - }, - "type": "object" - }, - "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" - }, - "links": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks" - }, - "type": "array" }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointRestConsumerResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" - }, - "links": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks" + "traceFiltersUri": { + "description": "The URI of this Telemetry Profile's collection of Trace Filter objects.", + "type": "string" }, - "meta": { - "$ref": "#/definitions/SempMeta" + "uri": { + "description": "The URI of this Telemetry Profile object.", + "type": "string" } }, - "required": [ - "meta" - ], "type": "object" }, - "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName": { + "MsgVpnTelemetryProfileQueueEventBindCountThreshold": { + "description": "The thresholds for the Queue consumer flows event, relative to `queueMaxBindCount`.", "properties": { - "msgVpnName": { - "description": "The name of the Message VPN. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-deprecated": true, - "x-identifying": true, + "x-configSyncDefault": 60, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, + "x-deprecated": false, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "restConsumerName": { - "description": "The name of the REST Consumer. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 32, - "minLength": 1, - "type": "string", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-deprecated": true, - "x-identifying": true, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 100, - "minLength": 1, - "type": "string", + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-deprecated": true, - "x-identifying": true, + "x-configSyncDefault": 80, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, + "x-deprecated": false, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "tlsTrustedCommonName": { - "description": "The expected trusted common name of the remote certificate. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 64, - "minLength": 1, - "type": "string", + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-deprecated": true, - "x-identifying": true, - "x-identifyingDirect": true, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], "x-requiresDisable": [], "x-writeOnly": false } }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks": { - "properties": { - "uri": { - "description": "The URI of this Trusted Common Name object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" - }, - "links": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], "type": "object" }, - "MsgVpnRestDeliveryPointRestConsumersResponse": { + "MsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold": { + "description": "The thresholds for the message spool usage event of the Queue, relative to `queueMaxMsgSpoolUsage`.", "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "type": "array" + "x-autoDisable": [], + "x-configSyncDefault": 60, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 1, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], + "x-requiresDisable": [], + "x-writeOnly": false }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks" + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "type": "array" + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnRestDeliveryPointsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPoint" + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "type": "array" + "x-autoDisable": [], + "x-configSyncDefault": 80, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 2, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], + "x-requiresDisable": [], + "x-writeOnly": false }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointLinks" + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false } }, - "required": [ - "meta" - ], "type": "object" }, - "MsgVpnSequencedTopic": { + "MsgVpnTelemetryProfileReceiverAclConnectException": { "properties": { "msgVpnName": { "description": "The name of the Message VPN.", @@ -29997,10 +28762,11 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "sequencedTopic": { - "description": "Topic for applying sequence numbers.", - "maxLength": 250, - "minLength": 1, + "receiverAclConnectExceptionAddress": { + "description": "The IP address/netmask of the receiver connect exception in CIDR form.", + "maxLength": 43, + "minLength": 0, + "pattern": "^\\s*((((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\\.){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[1-2][0-9]|3[0-2]))|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])))\\s*$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -30016,6 +28782,27 @@ "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false + }, + "telemetryProfileName": { + "description": "The name of the Telemetry Profile.", + "maxLength": 21, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-_]+$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only" + }, + "x-autoDisable": [], + "x-deprecated": false, + "x-identifying": true, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false } }, "type": "object", @@ -30025,22 +28812,22 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnSequencedTopicLinks": { + "MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks": { "properties": { "uri": { - "description": "The URI of this Sequenced Topic object.", + "description": "The URI of this Receiver ACL Connect Exception object.", "type": "string" } }, "type": "object" }, - "MsgVpnSequencedTopicResponse": { + "MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnSequencedTopic" + "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectException" }, "links": { - "$ref": "#/definitions/MsgVpnSequencedTopicLinks" + "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -30051,17 +28838,17 @@ ], "type": "object" }, - "MsgVpnSequencedTopicsResponse": { + "MsgVpnTelemetryProfileReceiverAclConnectExceptionsResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/MsgVpnSequencedTopic" + "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectException" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/MsgVpnSequencedTopicLinks" + "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks" }, "type": "array" }, @@ -30074,39 +28861,13 @@ ], "type": "object" }, - "MsgVpnTelemetryProfile": { + "MsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold": { + "description": "The thresholds for the receiver connection count event, relative to `receiverMaxConnectionCountPerClientUsername`.", "properties": { - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "queueEventBindCountThreshold": { - "$ref": "#/definitions/MsgVpnTelemetryProfileQueueEventBindCountThreshold" - }, - "queueEventMsgSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold" - }, - "queueMaxBindCount": { - "description": "The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 10000, + "maximum": 100, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -30114,108 +28875,152 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, + "x-configSyncDefault": 60, "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "queueMaxMsgSpoolUsage": { - "description": "The maximum message spool usage allowed by the Queue, in megabytes (MB). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `800000`.", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 6000000, - "minimum": 1, + "maximum": 200000, + "minimum": 0, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 800000, "x-configSyncTableType": "vpn", - "x-default": 800000, + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "receiverAclConnectDefaultAction": { - "description": "The default action to take when a receiver client connects to the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are:\n\n
\n\"allow\" - Allow client connection unless an exception is found for it.\n\"disallow\" - Disallow client connection unless an exception is found for it.\n
\n", - "enum": [ - "allow", - "disallow" - ], - "type": "string", + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "disallow", + "x-configSyncDefault": 80, "x-configSyncTableType": "vpn", - "x-default": "disallow", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "receiverEnabled": { - "description": "Enable or disable the ability for receiver clients to consume from the #telemetry queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 200000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-default": false, + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object" + }, + "MsgVpnTelemetryProfileResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnTelemetryProfile" }, - "receiverEventConnectionCountPerClientUsernameThreshold": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold" + "links": { + "$ref": "#/definitions/MsgVpnTelemetryProfileLinks" }, - "receiverMaxConnectionCountPerClientUsername": { - "description": "The maximum number of receiver connections per Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTelemetryProfileTraceFilter": { + "properties": { + "enabled": { + "description": "Enable or disable the trace filter. When the filter is disabled, the filter's subscriptions will not trigger a message to be traced. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -30227,153 +29032,169 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "receiverTcpCongestionWindowSize": { - "description": "The TCP initial congestion window size for clients using the Client Profile, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2`.", - "format": "int64", - "maximum": 7826, - "minimum": 2, - "type": "integer", + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 2, - "x-configSyncTableType": "vpn", - "x-default": 2, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "receiverTcpKeepaliveCount": { - "description": "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", - "format": "int64", - "maximum": 5, - "minimum": 2, - "type": "integer", + "telemetryProfileName": { + "description": "The name of the Telemetry Profile.", + "maxLength": 21, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-_]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 5, - "x-configSyncTableType": "vpn", - "x-default": 5, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "receiverTcpKeepaliveIdleTime": { - "description": "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 120, - "minimum": 3, - "type": "integer", + "traceFilterName": { + "description": "A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as \"appNameDebug\".", + "maxLength": 127, + "minLength": 1, + "pattern": "^[^#*? ]([^*?]*[^*? ])?$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 3, - "x-configSyncTableType": "vpn", - "x-default": 3, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnTelemetryProfileTraceFilterLinks": { + "properties": { + "subscriptionsUri": { + "description": "The URI of this Trace Filter's collection of Telemetry Trace Filter Subscription objects.", + "type": "string" }, - "receiverTcpKeepaliveInterval": { - "description": "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgment is received, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", - "format": "int64", - "maximum": 30, - "minimum": 1, - "type": "integer", + "uri": { + "description": "The URI of this Trace Filter object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnTelemetryProfileTraceFilterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilter" + }, + "links": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTelemetryProfileTraceFilterSubscription": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "x-default": 1, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "receiverTcpMaxSegmentSize": { - "description": "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1460`.", - "format": "int64", - "maximum": 1460, - "minimum": 256, - "type": "integer", + "subscription": { + "description": "Messages matching this subscription will follow this filter's configuration.", + "maxLength": 250, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 1460, - "x-configSyncTableType": "vpn", - "x-default": 1460, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "receiverTcpMaxWindowSize": { - "description": "The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. This setting is ignored on the software broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`.", - "format": "int64", - "maximum": 65536, - "minimum": 16, - "type": "integer", + "subscriptionSyntax": { + "description": "The syntax of the trace filter subscription. The allowed values and their meaning are:\n\n
\n\"smf\" - Subscription uses SMF syntax.\n\"mqtt\" - Subscription uses MQTT syntax.\n
\n", + "enum": [ + "smf", + "mqtt" + ], + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 256, - "x-configSyncTableType": "vpn", - "x-default": 256, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, @@ -30389,54 +29210,31 @@ "x-autoDisable": [], "x-deprecated": false, "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "traceEnabled": { - "description": "Enable or disable generation of all trace span data messages. When enabled, the state of configured trace filters control which messages get traced. When disabled, trace span data messages are never generated, regardless of the state of trace filters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "traceSendSpanGenerationEnabled": { - "description": "Enable or disable generation of send spans. For the most complete view of broker message processing, this should be enabled. If the information provided by send spans are not needed, send spans can be disabled to reduce the performance impact of tracing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.36.", - "type": "boolean", + "traceFilterName": { + "description": "A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as \"appNameDebug\".", + "maxLength": 127, + "minLength": 1, + "pattern": "^[^#*? ]([^*?]*[^*? ])?$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "vpn/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "vpn", - "x-default": true, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], @@ -30450,122 +29248,202 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnTelemetryProfileLinks": { + "MsgVpnTelemetryProfileTraceFilterSubscriptionLinks": { "properties": { - "receiverAclConnectExceptionsUri": { - "description": "The URI of this Telemetry Profile's collection of Receiver ACL Connect Exception objects.", + "uri": { + "description": "The URI of this Telemetry Trace Filter Subscription object.", "type": "string" + } + }, + "type": "object" + }, + "MsgVpnTelemetryProfileTraceFilterSubscriptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscription" }, - "traceFiltersUri": { - "description": "The URI of this Telemetry Profile's collection of Trace Filter objects.", - "type": "string" + "links": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscriptionLinks" }, - "uri": { - "description": "The URI of this Telemetry Profile object.", - "type": "string" + "meta": { + "$ref": "#/definitions/SempMeta" } }, + "required": [ + "meta" + ], "type": "object" }, - "MsgVpnTelemetryProfileQueueEventBindCountThreshold": { - "description": "The thresholds for the Queue consumer flows event, relative to `queueMaxBindCount`.", + "MsgVpnTelemetryProfileTraceFilterSubscriptionsResponse": { "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + "data": { + "items": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscription" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscriptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTelemetryProfileTraceFiltersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilter" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTelemetryProfilesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnTelemetryProfile" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnTelemetryProfileLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTopicEndpoint": { + "properties": { + "accessType": { + "description": "The access type for delivering messages to consumer flows bound to the Topic Endpoint. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n", + "enum": [ + "exclusive", + "non-exclusive" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": "exclusive", + "x-configSyncTableType": "vpn", + "x-default": "exclusive", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "consumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 60, + "x-configSyncDefault": true, "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "deadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ) used by the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[^*?'<>&;]+$", + "type": "string", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": "#DEAD_MSG_QUEUE", "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-default": "#DEAD_MSG_QUEUE", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setValue" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + "deliveryCountEnabled": { + "description": "Enable or disable the ability for client applications to query the message delivery count of messages received from the Topic Endpoint. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 80, + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "deliveryDelay": { + "description": "The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", "format": "int64", "maximum": 4294967295, "minimum": 0, @@ -30575,97 +29453,77 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold": { - "description": "The thresholds for the message spool usage event of the Queue, relative to `queueMaxMsgSpoolUsage`.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + }, + "egressEnabled": { + "description": "Enable or disable the transmission of messages from the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 60, + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 1, + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "eventBindCountThreshold": { + "$ref": "#/definitions/MsgVpnTopicEndpointEventBindCountThreshold" + }, + "eventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/MsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold" + }, + "eventSpoolUsageThreshold": { + "$ref": "#/definitions/MsgVpnTopicEndpointEventSpoolUsageThreshold" + }, + "ingressEnabled": { + "description": "Enable or disable the reception of messages to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": false, "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setValue" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "maxBindCount": { + "description": "The maximum number of consumer flows that can bind to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", "format": "int64", - "maximum": 100, + "maximum": 10000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -30673,62 +29531,145 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 80, + "x-configSyncDefault": 1, "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 2, + "x-default": 1, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "maxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow for the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", "format": "int64", - "maximum": 4294967295, - "minimum": 0, + "maximum": 1000000, + "minimum": 1, "type": "integer", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 10000, "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-default": 10000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnTelemetryProfileReceiverAclConnectException": { - "properties": { + }, + "maxMsgSize": { + "description": "The maximum message size allowed in the Topic Endpoint, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "format": "int32", + "maximum": 30000000, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 10000000, + "x-configSyncTableType": "vpn", + "x-default": 10000000, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "maxRedeliveryCount": { + "description": "The maximum number of times the Topic Endpoint will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 255, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "maxSpoolUsage": { + "description": "The maximum message spool usage allowed by the Topic Endpoint, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "format": "int64", + "maximum": 6000000, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 4000, + "x-configSyncTableType": "vpn", + "x-default": 5000, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "maxTtl": { + "description": "The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, "msgVpnName": { "description": "The name of the Message VPN.", "maxLength": 32, @@ -30750,32 +29691,318 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "receiverAclConnectExceptionAddress": { - "description": "The IP address/netmask of the receiver connect exception in CIDR form.", - "maxLength": 43, + "owner": { + "description": "The Client Username that owns the Topic Endpoint and has permission equivalent to `\"delete\"`. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 189, "minLength": 0, - "pattern": "^\\s*((((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\\.){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])/([0-9]|[1-2][0-9]|3[0-2]))|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])))\\s*$", "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "permission": { + "description": "The permission level for all consumers of the Topic Endpoint, excluding the owner. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", + "enum": [ + "no-access", + "read-only", + "consume", + "modify-topic", + "delete" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": "no-access", + "x-configSyncTableType": "vpn", + "x-default": "no-access", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "redeliveryDelayEnabled": { + "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as-soon-as-possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "redeliveryDelayInitialInterval": { + "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", + "format": "int32", + "maximum": 3600000, + "minimum": 1, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": 1000, + "x-configSyncTableType": "vpn", + "x-default": 1000, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "redeliveryDelayMaxInterval": { + "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", + "format": "int32", + "maximum": 10800000, + "minimum": 1, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": 64000, + "x-configSyncTableType": "vpn", + "x-default": 64000, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "redeliveryDelayMultiplier": { + "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", + "format": "int32", + "maximum": 500, + "minimum": 100, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled" + ], + "x-configSyncDefault": 200, + "x-configSyncTableType": "vpn", + "x-default": 200, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "redeliveryEnabled": { + "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": true, + "x-configSyncTableType": "vpn", + "x-default": true, "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "telemetryProfileName": { - "description": "The name of the Telemetry Profile.", - "maxLength": 21, + "rejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "rejectLowPriorityMsgLimit": { + "description": "The number of messages of any priority in the Topic Endpoint above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "rejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as rejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-topic-endpoint-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n", + "enum": [ + "never", + "when-topic-endpoint-enabled", + "always" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "rejectLowPriorityMsgEnabled" + ], + "x-configSyncDefault": "never", + "x-configSyncTableType": "vpn", + "x-default": "never", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "respectMsgPriorityEnabled": { + "description": "Enable or disable the respecting of message priority. When enabled, messages contained in the Topic Endpoint are delivered in priority order, from 9 (highest) to 0 (lowest). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled and ingressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "egressEnabled", + "ingressEnabled" + ], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "respectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the Topic Endpoint. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "topicEndpointName": { + "description": "The name of the Topic Endpoint.", + "maxLength": 200, "minLength": 1, - "pattern": "^[A-Za-z0-9\\-_]+$", + "pattern": "^[^*?'<>&;]+$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -30783,12 +30010,12 @@ "x-autoDisable": [], "x-deprecated": false, "x-identifying": true, - "x-identifyingDirect": false, + "x-identifyingDirect": true, "x-opaque": false, "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false } @@ -30800,57 +30027,8 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Receiver ACL Connect Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectException" - }, - "links": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTelemetryProfileReceiverAclConnectExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold": { - "description": "The thresholds for the receiver connection count event, relative to `receiverMaxConnectionCountPerClientUsername`.", + "MsgVpnTopicEndpointEventBindCountThreshold": { + "description": "The thresholds for the Topic Endpoint consumer flows event, relative to `maxBindCount`.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -30887,7 +30065,7 @@ "clearValue": { "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 200000, + "maximum": 4294967295, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -30949,7 +30127,7 @@ "setValue": { "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 200000, + "maximum": 4294967295, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -30979,348 +30157,282 @@ }, "type": "object" }, - "MsgVpnTelemetryProfileResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnTelemetryProfile" - }, - "links": { - "$ref": "#/definitions/MsgVpnTelemetryProfileLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTelemetryProfileTraceFilter": { + "MsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold": { + "description": "The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to `rejectLowPriorityMsgLimit`.", "properties": { - "enabled": { - "description": "Enable or disable the trace filter. When the filter is disabled, the filter's subscriptions will not trigger a message to be traced. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 60, "x-configSyncTableType": "vpn", - "x-default": false, + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "telemetryProfileName": { - "description": "The name of the Telemetry Profile.", - "maxLength": 21, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-_]+$", - "type": "string", + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 80, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "traceFilterName": { - "description": "A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as \"appNameDebug\".", - "maxLength": 127, - "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", - "type": "string", + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], "x-requiresDisable": [], "x-writeOnly": false } }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnTelemetryProfileTraceFilterLinks": { - "properties": { - "subscriptionsUri": { - "description": "The URI of this Trace Filter's collection of Telemetry Trace Filter Subscription objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Trace Filter object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnTelemetryProfileTraceFilterResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilter" - }, - "links": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], "type": "object" }, - "MsgVpnTelemetryProfileTraceFilterSubscription": { + "MsgVpnTopicEndpointEventSpoolUsageThreshold": { + "description": "The thresholds for the message spool usage event of the Topic Endpoint, relative to `maxSpoolUsage`.", "properties": { - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 60, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 18, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "subscription": { - "description": "Messages matching this subscription will follow this filter's configuration.", - "maxLength": 250, - "minLength": 1, - "type": "string", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "subscriptionSyntax": { - "description": "The syntax of the trace filter subscription. The allowed values and their meaning are:\n\n
\n\"smf\" - Subscription uses SMF syntax.\n\"mqtt\" - Subscription uses MQTT syntax.\n
\n", - "enum": [ - "smf", - "mqtt" + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "telemetryProfileName": { - "description": "The name of the Telemetry Profile.", - "maxLength": 21, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-_]+$", - "type": "string", + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 80, + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 25, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "traceFilterName": { - "description": "A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as \"appNameDebug\".", - "maxLength": 127, - "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", - "type": "string", + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only" + "get": "vpn/read-only", + "patch": "vpn/read-write" }, "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], "x-requiresDisable": [], "x-writeOnly": false } }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" + "type": "object" }, - "MsgVpnTelemetryProfileTraceFilterSubscriptionLinks": { + "MsgVpnTopicEndpointLinks": { "properties": { "uri": { - "description": "The URI of this Telemetry Trace Filter Subscription object.", + "description": "The URI of this Topic Endpoint object.", "type": "string" } }, "type": "object" }, - "MsgVpnTelemetryProfileTraceFilterSubscriptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscription" - }, - "links": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscriptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTelemetryProfileTraceFilterSubscriptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscription" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscriptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTelemetryProfileTraceFiltersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilter" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTelemetryProfilesResponse": { + "MsgVpnTopicEndpointResponse": { "properties": { "data": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfile" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnTopicEndpoint" }, "links": { - "items": { - "$ref": "#/definitions/MsgVpnTelemetryProfileLinks" - }, - "type": "array" + "$ref": "#/definitions/MsgVpnTopicEndpointLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -31331,10 +30443,10 @@ ], "type": "object" }, - "MsgVpnTopicEndpoint": { + "MsgVpnTopicEndpointTemplate": { "properties": { "accessType": { - "description": "The access type for delivering messages to consumer flows bound to the Topic Endpoint. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n Available since 2.4.", + "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n", "enum": [ "exclusive", "non-exclusive" @@ -31344,9 +30456,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": "exclusive", "x-configSyncTableType": "vpn", "x-default": "exclusive", @@ -31384,7 +30494,7 @@ "x-writeOnly": false }, "deadMsgQueue": { - "description": "The name of the Dead Message Queue (DMQ) used by the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2.", + "description": "The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", "maxLength": 200, "minLength": 1, "pattern": "^[^*?'<>&;]+$", @@ -31408,28 +30518,6 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "deliveryCountEnabled": { - "description": "Enable or disable the ability for client applications to query the message delivery count of messages received from the Topic Endpoint. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, "deliveryDelay": { "description": "The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", "format": "int64", @@ -31455,61 +30543,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "egressEnabled": { - "description": "Enable or disable the transmission of messages from the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, "eventBindCountThreshold": { - "$ref": "#/definitions/MsgVpnTopicEndpointEventBindCountThreshold" - }, - "eventRejectLowPriorityMsgLimitThreshold": { - "$ref": "#/definitions/MsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold" + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateEventBindCountThreshold" }, - "eventSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnTopicEndpointEventSpoolUsageThreshold" + "eventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold" }, - "ingressEnabled": { - "description": "Enable or disable the reception of messages to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "eventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold" }, "maxBindCount": { - "description": "The maximum number of consumer flows that can bind to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Available since 2.4.", + "description": "The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", "format": "int64", "maximum": 10000, "minimum": 0, @@ -31534,7 +30578,7 @@ "x-writeOnly": false }, "maxDeliveredUnackedMsgsPerFlow": { - "description": "The maximum number of messages delivered but not acknowledged per flow for the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "description": "The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", "format": "int64", "maximum": 1000000, "minimum": 1, @@ -31559,7 +30603,7 @@ "x-writeOnly": false }, "maxMsgSize": { - "description": "The maximum message size allowed in the Topic Endpoint, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "description": "The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", "format": "int32", "maximum": 30000000, "minimum": 0, @@ -31583,10 +30627,10 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "maxRedeliveryCount": { - "description": "The maximum number of times the Topic Endpoint will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "maxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", "format": "int64", - "maximum": 255, + "maximum": 6000000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -31594,9 +30638,9 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 0, + "x-configSyncDefault": 4000, "x-configSyncTableType": "vpn", - "x-default": 0, + "x-default": 5000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -31608,10 +30652,10 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "maxSpoolUsage": { - "description": "The maximum message spool usage allowed by the Topic Endpoint, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "maxRedeliveryCount": { + "description": "The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", - "maximum": 6000000, + "maximum": 255, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -31619,9 +30663,9 @@ "patch": "vpn/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 1500, + "x-configSyncDefault": 0, "x-configSyncTableType": "vpn", - "x-default": 5000, + "x-default": 0, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -31679,34 +30723,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "owner": { - "description": "The Client Username that owns the Topic Endpoint and has permission equivalent to `\"delete\"`. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 189, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "egressEnabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, "permission": { - "description": "The permission level for all consumers of the Topic Endpoint, excluding the owner. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", + "description": "The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", "enum": [ "no-access", "read-only", @@ -31719,9 +30737,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": "no-access", "x-configSyncTableType": "vpn", "x-default": "no-access", @@ -31737,15 +30753,13 @@ "x-writeOnly": false }, "redeliveryDelayEnabled": { - "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as-soon-as-possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", + "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as-soon-as-possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": false, "x-configSyncTableType": "vpn", "x-default": false, @@ -31761,7 +30775,7 @@ "x-writeOnly": false }, "redeliveryDelayInitialInterval": { - "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", + "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", "format": "int32", "maximum": 3600000, "minimum": 1, @@ -31770,9 +30784,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": 1000, "x-configSyncTableType": "vpn", "x-default": 1000, @@ -31788,7 +30800,7 @@ "x-writeOnly": false }, "redeliveryDelayMaxInterval": { - "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", + "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", "format": "int32", "maximum": 10800000, "minimum": 1, @@ -31797,9 +30809,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": 64000, "x-configSyncTableType": "vpn", "x-default": 64000, @@ -31815,7 +30825,7 @@ "x-writeOnly": false }, "redeliveryDelayMultiplier": { - "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", + "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", "format": "int32", "maximum": 500, "minimum": 100, @@ -31824,9 +30834,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": 200, "x-configSyncTableType": "vpn", "x-default": 200, @@ -31886,7 +30894,7 @@ "x-writeOnly": false }, "rejectLowPriorityMsgLimit": { - "description": "The number of messages of any priority in the Topic Endpoint above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "description": "The number of messages that are permitted before low priority messages are rejected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", "maximum": 4294967295, "minimum": 0, @@ -31911,7 +30919,7 @@ "x-writeOnly": false }, "rejectMsgToSenderOnDiscardBehavior": { - "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as rejectLowPriorityMsgEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-topic-endpoint-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n", + "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-topic-endpoint-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n", "enum": [ "never", "when-topic-endpoint-enabled", @@ -31922,9 +30930,7 @@ "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "rejectLowPriorityMsgEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": "never", "x-configSyncTableType": "vpn", "x-default": "never", @@ -31940,16 +30946,13 @@ "x-writeOnly": false }, "respectMsgPriorityEnabled": { - "description": "Enable or disable the respecting of message priority. When enabled, messages contained in the Topic Endpoint are delivered in priority order, from 9 (highest) to 0 (lowest). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled and ingressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", + "description": "Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", "patch": "vpn/read-write" }, - "x-autoDisable": [ - "egressEnabled", - "ingressEnabled" - ], + "x-autoDisable": [], "x-configSyncDefault": false, "x-configSyncTableType": "vpn", "x-default": false, @@ -31965,7 +30968,7 @@ "x-writeOnly": false }, "respectTtlEnabled": { - "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the Topic Endpoint. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -31986,11 +30989,35 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "topicEndpointName": { - "description": "The name of the Topic Endpoint.", + "topicEndpointNameFilter": { + "description": "A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 200, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, + "topicEndpointTemplateName": { + "description": "The name of the Topic Endpoint Template.", + "maxLength": 255, "minLength": 1, - "pattern": "^[^*?'<>&;]+$", + "pattern": "^[^#?*][^?*]*$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -32015,8 +31042,8 @@ }, "x-configSyncTableTypeCreateDelete": "vpn" }, - "MsgVpnTopicEndpointEventBindCountThreshold": { - "description": "The thresholds for the Topic Endpoint consumer flows event, relative to `maxBindCount`. Available since 2.4.", + "MsgVpnTopicEndpointTemplateEventBindCountThreshold": { + "description": "The thresholds for the Topic Endpoint consumer flows event, relative to `maxBindCount`.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -32053,7 +31080,7 @@ "clearValue": { "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 10000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -32115,7 +31142,7 @@ "setValue": { "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 10000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -32145,8 +31172,8 @@ }, "type": "object" }, - "MsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold": { - "description": "The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to `rejectLowPriorityMsgLimit`.", + "MsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold": { + "description": "The thresholds for the message spool usage event of the Topic Endpoint, relative to `maxSpoolUsage`.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -32165,7 +31192,7 @@ "clearValue", "setValue" ], - "x-default": 60, + "x-default": 18, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32183,7 +31210,7 @@ "clearValue": { "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 6000000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -32227,7 +31254,7 @@ "clearValue", "setValue" ], - "x-default": 80, + "x-default": 25, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32245,7 +31272,7 @@ "setValue": { "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 4294967295, + "maximum": 6000000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -32275,8 +31302,8 @@ }, "type": "object" }, - "MsgVpnTopicEndpointEventSpoolUsageThreshold": { - "description": "The thresholds for the message spool usage event of the Topic Endpoint, relative to `maxSpoolUsage`.", + "MsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold": { + "description": "The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to `rejectLowPriorityMsgLimit`.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -32295,7 +31322,7 @@ "clearValue", "setValue" ], - "x-default": 18, + "x-default": 60, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32357,7 +31384,7 @@ "clearValue", "setValue" ], - "x-default": 25, + "x-default": 80, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32405,22 +31432,22 @@ }, "type": "object" }, - "MsgVpnTopicEndpointLinks": { + "MsgVpnTopicEndpointTemplateLinks": { "properties": { "uri": { - "description": "The URI of this Topic Endpoint object.", + "description": "The URI of this Topic Endpoint Template object.", "type": "string" } }, "type": "object" }, - "MsgVpnTopicEndpointResponse": { + "MsgVpnTopicEndpointTemplateResponse": { "properties": { "data": { - "$ref": "#/definitions/MsgVpnTopicEndpoint" + "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" }, "links": { - "$ref": "#/definitions/MsgVpnTopicEndpointLinks" + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -32431,23 +31458,90 @@ ], "type": "object" }, - "MsgVpnTopicEndpointTemplate": { + "MsgVpnTopicEndpointTemplatesResponse": { "properties": { - "accessType": { - "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n
\n", - "enum": [ - "exclusive", - "non-exclusive" - ], + "data": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTopicEndpointsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpoint" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpointLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpn" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfile": { + "properties": { + "accessLevelGroupsClaimName": { + "description": "The name of the groups claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"groups\"`.", + "maxLength": 100, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "exclusive", - "x-configSyncTableType": "vpn", - "x-default": "exclusive", + "x-configSyncDefault": "groups", + "x-configSyncTableType": "router", + "x-default": "groups", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32459,17 +31553,21 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "consumerAckPropagationEnabled": { - "description": "Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", - "type": "boolean", + "accessLevelGroupsClaimStringFormat": { + "description": "The format of the access level groups claim value when it is a string. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"single\"`. The allowed values and their meaning are:\n\n
\n\"single\" - When the claim is a string, it is interpreted as as single group.\n\"space-delimited\" - When the claim is a string, it is interpreted as a space-delimited list of groups, similar to the \"scope\" claim.\n
\n Available since 2.32.", + "enum": [ + "single", + "space-delimited" + ], + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "vpn", - "x-default": true, + "x-configSyncDefault": "single", + "x-configSyncTableType": "router", + "x-default": "single", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32481,20 +31579,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "deadMsgQueue": { - "description": "The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", + "clientId": { + "description": "The OAuth client id. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "#DEAD_MSG_QUEUE", - "x-configSyncTableType": "vpn", - "x-default": "#DEAD_MSG_QUEUE", + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32506,20 +31603,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "deliveryDelay": { - "description": "The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "clientRedirectUri": { + "description": "The OAuth redirect URI. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 300, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32531,29 +31627,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "eventBindCountThreshold": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateEventBindCountThreshold" - }, - "eventMsgSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold" - }, - "eventRejectLowPriorityMsgLimitThreshold": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold" - }, - "maxBindCount": { - "description": "The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", - "format": "int64", - "maximum": 10000, - "minimum": 0, - "type": "integer", + "clientRequiredType": { + "description": "The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"JWT\"`.", + "maxLength": 200, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "x-default": 1, + "x-configSyncDefault": "JWT", + "x-configSyncTableType": "router", + "x-default": "JWT", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32565,20 +31651,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "maxDeliveredUnackedMsgsPerFlow": { - "description": "The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", - "format": "int64", - "maximum": 1000000, - "minimum": 1, - "type": "integer", + "clientScope": { + "description": "The OAuth scope. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"openid email\"`.", + "maxLength": 200, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 10000, - "x-configSyncTableType": "vpn", - "x-default": 10000, + "x-configSyncDefault": "openid email", + "x-configSyncTableType": "router", + "x-default": "openid email", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32590,45 +31675,40 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "maxMsgSize": { - "description": "The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", - "format": "int32", - "maximum": 30000000, - "minimum": 0, - "type": "integer", + "clientSecret": { + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 512, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 10000000, - "x-configSyncTableType": "vpn", - "x-default": 10000000, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": false, + "x-opaque": true, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], - "x-writeOnly": false + "x-writeOnly": true }, - "maxMsgSpoolUsage": { - "description": "The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", + "clientValidateTypeEnabled": { + "description": "Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 1500, - "x-configSyncTableType": "vpn", - "x-default": 5000, + "x-configSyncDefault": true, + "x-configSyncTableType": "router", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32640,20 +31720,23 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "maxRedeliveryCount": { - "description": "The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 255, - "minimum": 0, - "type": "integer", + "defaultGlobalAccessLevel": { + "description": "The default global access level for this OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to global data.\n\"read-only\" - User has read-only access to global data.\n\"read-write\" - User has read-write access to most global data.\n\"admin\" - User has read-write access to all global data.\n
\n", + "enum": [ + "none", + "read-only", + "read-write", + "admin" + ], + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, + "x-configSyncDefault": "none", + "x-configSyncTableType": "router", + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32665,20 +31748,22 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "maxTtl": { - "description": "The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "defaultMsgVpnAccessLevel": { + "description": "The default message VPN access level for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, + "x-configSyncDefault": "none", + "x-configSyncTableType": "router", + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32690,45 +31775,41 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", + "displayName": { + "description": "The user friendly name for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 64, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "permission": { - "description": "The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", - "enum": [ - "no-access", - "read-only", - "consume", - "modify-topic", - "delete" - ], - "type": "string", + "enabled": { + "description": "Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "no-access", - "x-configSyncTableType": "vpn", - "x-default": "no-access", + "x-configSyncDefault": false, + "x-configSyncTableType": "router", + "x-default": false, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32740,17 +31821,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayEnabled": { - "description": "Enable or disable a message redelivery delay. When false, messages are redelivered as-soon-as-possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.33.", - "type": "boolean", + "endpointAuthorization": { + "description": "The OAuth authorization endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32762,20 +31845,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayInitialInterval": { - "description": "The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.33.", - "format": "int32", - "maximum": 3600000, - "minimum": 1, - "type": "integer", + "endpointDiscovery": { + "description": "The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 1000, - "x-configSyncTableType": "vpn", - "x-default": 1000, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32787,20 +31869,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayMaxInterval": { - "description": "The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since 2.33.", + "endpointDiscoveryRefreshInterval": { + "description": "The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", "format": "int32", - "maximum": 10800000, - "minimum": 1, - "type": "integer", + "maximum": 31536000, + "minimum": 60, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 64000, - "x-configSyncTableType": "vpn", - "x-default": 64000, + "x-configSyncDefault": 86400, + "x-configSyncTableType": "router", + "x-default": 86400, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32812,20 +31894,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryDelayMultiplier": { - "description": "The amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 would cause the delay to be multiplied by 1.25. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `200`. Available since 2.33.", - "format": "int32", - "maximum": 500, - "minimum": 100, - "type": "integer", + "endpointIntrospection": { + "description": "The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 200, - "x-configSyncTableType": "vpn", - "x-default": 200, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32837,17 +31918,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "redeliveryEnabled": { - "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", - "type": "boolean", + "endpointIntrospectionTimeout": { + "description": "The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", + "format": "int32", + "maximum": 60, + "minimum": 1, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "vpn", - "x-default": true, + "x-configSyncDefault": 1, + "x-configSyncTableType": "router", + "x-default": 1, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32859,17 +31943,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "rejectLowPriorityMsgEnabled": { - "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "endpointJwks": { + "description": "The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32881,20 +31967,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "rejectLowPriorityMsgLimit": { - "description": "The number of messages that are permitted before low priority messages are rejected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, + "endpointJwksRefreshInterval": { + "description": "The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", + "format": "int32", + "maximum": 31536000, + "minimum": 60, "type": "integer", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "vpn", - "x-default": 0, + "x-configSyncDefault": 86400, + "x-configSyncTableType": "router", + "x-default": 86400, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32906,22 +31992,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "rejectMsgToSenderOnDiscardBehavior": { - "description": "Determines when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are:\n\n
\n\"never\" - Silently discard messages.\n\"when-topic-endpoint-enabled\" - NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled.\n\"always\" - NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled.\n
\n", - "enum": [ - "never", - "when-topic-endpoint-enabled", - "always" - ], + "endpointToken": { + "description": "The OAuth token endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "never", - "x-configSyncTableType": "vpn", - "x-default": "never", + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32933,17 +32016,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "respectMsgPriorityEnabled": { - "description": "Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "endpointTokenTimeout": { + "description": "The maximum time in seconds a token request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", + "format": "int32", + "maximum": 60, + "minimum": 1, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, + "x-configSyncDefault": 1, + "x-configSyncTableType": "router", + "x-default": 1, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32955,17 +32041,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "respectTtlEnabled": { - "description": "Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", - "type": "boolean", + "endpointUserinfo": { + "description": "The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -32977,19 +32065,20 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "topicEndpointNameFilter": { - "description": "A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", + "endpointUserinfoTimeout": { + "description": "The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", + "format": "int32", + "maximum": 60, + "minimum": 1, + "type": "integer", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", + "x-configSyncDefault": 1, + "x-configSyncTableType": "router", + "x-default": 1, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33001,535 +32090,276 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "topicEndpointTemplateName": { - "description": "The name of the Topic Endpoint Template.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[^#?*][^?*]*$", - "type": "string", + "interactiveEnabled": { + "description": "Enable or disable interactive logins via this OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], + "x-configSyncDefault": true, + "x-configSyncTableType": "router", + "x-default": true, "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnTopicEndpointTemplateEventBindCountThreshold": { - "description": "The thresholds for the Topic Endpoint consumer flows event, relative to `maxBindCount`.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + }, + "interactivePromptForExpiredSession": { + "description": "The value of the prompt parameter provided to the OAuth authorization server for login requests where the session has expired. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 32, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 10000, - "minimum": 0, - "type": "integer", + "interactivePromptForNewSession": { + "description": "The value of the prompt parameter provided to the OAuth authorization server for login requests where the session is new or the user has explicitly logged out. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"select_account\"`.", + "maxLength": 32, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-configSyncDefault": "select_account", + "x-configSyncTableType": "router", + "x-default": "select_account", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setValue" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + "issuer": { + "description": "The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 10000, - "minimum": 0, - "type": "integer", + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9_]+$", + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], + "x-readOptional": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold": { - "description": "The thresholds for the message spool usage event of the Topic Endpoint, relative to `maxSpoolUsage`.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + }, + "oauthRole": { + "description": "The OAuth role of the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"client\"`. The allowed values and their meaning are:\n\n
\n\"client\" - The broker is in the OAuth client role.\n\"resource-server\" - The broker is in the OAuth resource server role.\n
\n", + "enum": [ + "client", + "resource-server" + ], + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 18, + "x-configSyncDefault": "client", + "x-configSyncTableType": "router", + "x-default": "client", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", + "resourceServerParseAccessTokenEnabled": { + "description": "Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-configSyncDefault": true, + "x-configSyncTableType": "router", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setValue" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + "resourceServerRequiredAudience": { + "description": "The required audience value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 200, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 25, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", + "resourceServerRequiredIssuer": { + "description": "The required issuer value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold": { - "description": "The thresholds for the maximum allowed number of any priority messages queued in the Topic Endpoint event, relative to `rejectLowPriorityMsgLimit`.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + }, + "resourceServerRequiredScope": { + "description": "A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 200, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", + "resourceServerRequiredType": { + "description": "The required TYP value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"at+jwt\"`.", + "maxLength": 200, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" + "get": "global/read-only", + "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], + "x-configSyncDefault": "at+jwt", + "x-configSyncTableType": "router", + "x-default": "at+jwt", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnTopicEndpointTemplateLinks": { - "properties": { - "uri": { - "description": "The URI of this Topic Endpoint Template object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnTopicEndpointTemplateResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" - }, - "links": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTopicEndpointTemplatesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTopicEndpointsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnTopicEndpoint" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnTopicEndpointLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpn" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnLinks" - }, - "type": "array" }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfile": { - "properties": { - "accessLevelGroupsClaimName": { - "description": "The name of the groups claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"groups\"`.", - "maxLength": 100, - "minLength": 0, - "type": "string", + "resourceServerValidateAudienceEnabled": { + "description": "Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "global/read-only", "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "groups", + "x-configSyncDefault": true, "x-configSyncTableType": "router", - "x-default": "groups", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33541,21 +32371,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "accessLevelGroupsClaimStringFormat": { - "description": "The format of the access level groups claim value when it is a string. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"single\"`. The allowed values and their meaning are:\n\n
\n\"single\" - When the claim is a string, it is interpreted as as single group.\n\"space-delimited\" - When the claim is a string, it is interpreted as a space-delimited list of groups, similar to the \"scope\" claim.\n
\n Available since 2.32.", - "enum": [ - "single", - "space-delimited" - ], - "type": "string", + "resourceServerValidateIssuerEnabled": { + "description": "Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "global/read-only", "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "single", + "x-configSyncDefault": true, "x-configSyncTableType": "router", - "x-default": "single", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33567,19 +32393,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "clientId": { - "description": "The OAuth client id. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", + "resourceServerValidateScopeEnabled": { + "description": "Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "global/read-only", "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "", + "x-configSyncDefault": true, "x-configSyncTableType": "router", - "x-default": "", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33591,19 +32415,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "clientRedirectUri": { - "description": "The OAuth redirect URI. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 300, - "minLength": 0, - "type": "string", + "resourceServerValidateTypeEnabled": { + "description": "Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "global/read-only", "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "", + "x-configSyncDefault": true, "x-configSyncTableType": "router", - "x-default": "", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33615,19 +32437,17 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "clientRequiredType": { - "description": "The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"JWT\"`.", - "maxLength": 200, - "minLength": 1, - "type": "string", + "sempEnabled": { + "description": "Enable or disable authentication of SEMP requests with OAuth tokens. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean", "x-accessLevels": { "get": "global/read-only", "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "JWT", + "x-configSyncDefault": true, "x-configSyncTableType": "router", - "x-default": "JWT", + "x-default": true, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33639,19 +32459,19 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "clientScope": { - "description": "The OAuth scope. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"openid email\"`.", - "maxLength": 200, - "minLength": 0, + "usernameClaimName": { + "description": "The name of the username claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"sub\"`.", + "maxLength": 100, + "minLength": 1, "type": "string", "x-accessLevels": { "get": "global/read-only", "patch": "global/admin" }, "x-autoDisable": [], - "x-configSyncDefault": "openid email", + "x-configSyncDefault": "sub", "x-configSyncTableType": "router", - "x-default": "openid email", + "x-default": "sub", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33662,14 +32482,25 @@ "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false - }, - "clientSecret": { - "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 512, + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/admin", + "post": "global/admin" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "OauthProfileAccessLevelGroup": { + "properties": { + "description": { + "description": "A description for the group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 64, "minLength": 0, "type": "string", "x-accessLevels": { - "patch": "global/admin" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], "x-configSyncDefault": "", @@ -33678,28 +32509,6 @@ "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true - }, - "clientValidateTypeEnabled": { - "description": "Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, @@ -33708,8 +32517,8 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "defaultGlobalAccessLevel": { - "description": "The default global access level for this OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to global data.\n\"read-only\" - User has read-only access to global data.\n\"read-write\" - User has read-write access to most global data.\n\"admin\" - User has read-write access to all global data.\n
\n", + "globalAccessLevel": { + "description": "The global access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to global data.\n\"read-only\" - User has read-only access to global data.\n\"read-write\" - User has read-write access to most global data.\n\"admin\" - User has read-write access to all global data.\n
\n", "enum": [ "none", "read-only", @@ -33736,46 +32545,42 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "defaultMsgVpnAccessLevel": { - "description": "The default message VPN access level for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", - "enum": [ - "none", - "read-only", - "read-write" - ], + "groupName": { + "description": "The name of the group.", + "maxLength": 64, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "none", - "x-configSyncTableType": "router", - "x-default": "none", "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "displayName": { - "description": "The user friendly name for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, + "msgVpnAccessLevel": { + "description": "The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], "type": "string", "x-accessLevels": { "get": "global/read-only", - "patch": "global/admin" + "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "", + "x-configSyncDefault": "none", "x-configSyncTableType": "router", - "x-default": "", + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33787,41 +32592,66 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "enabled": { - "description": "Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9_]+$", + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "router", - "x-default": false, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/read-write", + "post": "global/read-write" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "OauthProfileAccessLevelGroupLinks": { + "properties": { + "msgVpnAccessLevelExceptionsUri": { + "description": "The URI of this Group Access Level's collection of Message VPN Access-Level Exception objects.", + "type": "string" }, - "endpointAuthorization": { - "description": "The OAuth authorization endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, + "uri": { + "description": "The URI of this Group Access Level object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelException": { + "properties": { + "accessLevel": { + "description": "The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], "type": "string", "x-accessLevels": { "get": "global/read-only", - "patch": "global/admin" + "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "", + "x-configSyncDefault": "none", "x-configSyncTableType": "router", - "x-default": "", + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -33833,204 +32663,289 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "endpointDiscovery": { - "description": "The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, + "groupName": { + "description": "The name of the group.", + "maxLength": 64, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false }, - "endpointDiscoveryRefreshInterval": { - "description": "The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", - "format": "int32", - "maximum": 31536000, - "minimum": 60, - "type": "integer", + "msgVpnName": { + "description": "The name of the message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "router", - "x-default": 86400, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "endpointIntrospection": { - "description": "The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/read-write", + "post": "global/read-write" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Message VPN Access-Level Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" }, - "endpointIntrospectionTimeout": { - "description": "The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", - "format": "int32", - "maximum": 60, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "router", - "x-default": 1, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "links": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks" }, - "endpointJwks": { - "description": "The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "endpointJwksRefreshInterval": { - "description": "The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", - "format": "int32", - "maximum": 31536000, - "minimum": 60, - "type": "integer", + "links": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileAccessLevelGroupResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileAccessLevelGroup" + }, + "links": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileAccessLevelGroupsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroup" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAllowedHost": { + "properties": { + "allowedHost": { + "description": "An allowed value for the Host header.", + "maxLength": 255, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "router", - "x-default": 86400, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "endpointToken": { - "description": "The OAuth token endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/admin", + "post": "global/admin" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "OauthProfileClientAllowedHostLinks": { + "properties": { + "uri": { + "description": "The URI of this Allowed Host Value object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientAllowedHostResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileClientAllowedHost" }, - "endpointTokenTimeout": { - "description": "The maximum time in seconds a token request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", - "format": "int32", - "maximum": 60, - "minimum": 1, - "type": "integer", + "links": { + "$ref": "#/definitions/OauthProfileClientAllowedHostLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAllowedHostsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileClientAllowedHost" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileClientAllowedHostLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAuthorizationParameter": { + "properties": { + "authorizationParameterName": { + "description": "The name of the authorization parameter.", + "maxLength": 32, + "minLength": 1, + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "router", - "x-default": 1, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "endpointUserinfo": { - "description": "The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "authorizationParameterValue": { + "description": "The authorization parameter value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -34053,122 +32968,123 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "endpointUserinfoTimeout": { - "description": "The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", - "format": "int32", - "maximum": 60, - "minimum": 1, - "type": "integer", + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9_]+$", + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "router", - "x-default": 1, "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/admin", + "post": "global/admin" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "OauthProfileClientAuthorizationParameterLinks": { + "properties": { + "uri": { + "description": "The URI of this Authorization Parameter object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientAuthorizationParameterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" }, - "interactiveEnabled": { - "description": "Enable or disable interactive logins via this OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "links": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAuthorizationParametersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "interactivePromptForExpiredSession": { - "description": "The value of the prompt parameter provided to the OAuth authorization server for login requests where the session has expired. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 32, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "links": { + "items": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterLinks" }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "interactivePromptForNewSession": { - "description": "The value of the prompt parameter provided to the OAuth authorization server for login requests where the session is new or the user has explicitly logged out. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"select_account\"`.", - "maxLength": 32, - "minLength": 0, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientRequiredClaim": { + "properties": { + "clientRequiredClaimName": { + "description": "The name of the ID token claim to verify.", + "maxLength": 100, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "select_account", - "x-configSyncTableType": "router", - "x-default": "select_account", "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "issuer": { - "description": "The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, + "clientRequiredClaimValue": { + "description": "The required claim value, which must be a string containing a valid JSON value.", + "maxLength": 200, + "minLength": 1, "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, @@ -34184,30 +33100,90 @@ "x-autoDisable": [], "x-deprecated": false, "x-identifying": true, - "x-identifyingDirect": true, + "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": true, - "x-readOnlyPost": false, + "x-readOnlyPost": true, "x-readOptional": false, - "x-requiredPost": true, + "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/admin", + "post": "global/admin" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "OauthProfileClientRequiredClaimLinks": { + "properties": { + "uri": { + "description": "The URI of this Required Claim object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientRequiredClaimResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileClientRequiredClaim" }, - "oauthRole": { - "description": "The OAuth role of the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"client\"`. The allowed values and their meaning are:\n\n
\n\"client\" - The broker is in the OAuth client role.\n\"resource-server\" - The broker is in the OAuth resource server role.\n
\n", + "links": { + "$ref": "#/definitions/OauthProfileClientRequiredClaimLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientRequiredClaimsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileClientRequiredClaim" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileClientRequiredClaimLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileDefaultMsgVpnAccessLevelException": { + "properties": { + "accessLevel": { + "description": "The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", "enum": [ - "client", - "resource-server" + "none", + "read-only", + "read-write" ], "type": "string", "x-accessLevels": { "get": "global/read-only", - "patch": "global/admin" + "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "client", + "x-configSyncDefault": "none", "x-configSyncTableType": "router", - "x-default": "client", + "x-default": "none", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -34219,253 +33195,43 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "resourceServerParseAccessTokenEnabled": { - "description": "Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", + "msgVpnName": { + "description": "The name of the message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": true, + "x-identifyingDirect": true, "x-opaque": false, - "x-readOnlyOther": false, + "x-readOnlyOther": true, "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false }, - "resourceServerRequiredAudience": { - "description": "The required audience value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" + "get": "global/read-only" }, "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", "x-deprecated": false, - "x-identifying": false, + "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerRequiredIssuer": { - "description": "The required issuer value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerRequiredScope": { - "description": "A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerRequiredType": { - "description": "The required TYP value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"at+jwt\"`.", - "maxLength": 200, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "at+jwt", - "x-configSyncTableType": "router", - "x-default": "at+jwt", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerValidateAudienceEnabled": { - "description": "Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerValidateIssuerEnabled": { - "description": "Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerValidateScopeEnabled": { - "description": "Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerValidateTypeEnabled": { - "description": "Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "sempEnabled": { - "description": "Enable or disable authentication of SEMP requests with OAuth tokens. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": true, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "usernameClaimName": { - "description": "The name of the username claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"sub\"`.", - "maxLength": 100, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "sub", - "x-configSyncTableType": "router", - "x-default": "sub", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], @@ -34474,187 +33240,100 @@ }, "type": "object", "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" + "delete": "global/read-write", + "post": "global/read-write" }, "x-configSyncTableTypeCreateDelete": "router" }, - "OauthProfileAccessLevelGroup": { + "OauthProfileDefaultMsgVpnAccessLevelExceptionLinks": { "properties": { - "description": { - "description": "A description for the group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "uri": { + "description": "The URI of this Message VPN Access-Level Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileDefaultMsgVpnAccessLevelExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" }, - "globalAccessLevel": { - "description": "The global access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to global data.\n\"read-only\" - User has read-only access to global data.\n\"read-write\" - User has read-write access to most global data.\n\"admin\" - User has read-write access to all global data.\n
\n", - "enum": [ - "none", - "read-only", - "read-write", - "admin" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "none", - "x-configSyncTableType": "router", - "x-default": "none", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "links": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks" }, - "groupName": { - "description": "The name of the group.", - "maxLength": 64, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "msgVpnAccessLevel": { - "description": "The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", - "enum": [ - "none", - "read-only", - "read-write" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" + "links": { + "items": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks" }, - "x-autoDisable": [], - "x-configSyncDefault": "none", - "x-configSyncTableType": "router", - "x-default": "none", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "type": "array" }, - "oauthProfileName": { - "description": "The name of the OAuth profile.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[A-Za-z0-9_]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "meta": { + "$ref": "#/definitions/SempMeta" } }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" + "required": [ + "meta" + ], + "type": "object" }, - "OauthProfileAccessLevelGroupLinks": { + "OauthProfileLinks": { "properties": { - "msgVpnAccessLevelExceptionsUri": { - "description": "The URI of this Group Access Level's collection of Message VPN Access-Level Exception objects.", + "accessLevelGroupsUri": { + "description": "The URI of this OAuth Profile's collection of Group Access Level objects.", + "type": "string" + }, + "clientAllowedHostsUri": { + "description": "The URI of this OAuth Profile's collection of Allowed Host Value objects.", + "type": "string" + }, + "clientAuthorizationParametersUri": { + "description": "The URI of this OAuth Profile's collection of Authorization Parameter objects.", + "type": "string" + }, + "clientRequiredClaimsUri": { + "description": "The URI of this OAuth Profile's collection of Required Claim objects.", + "type": "string" + }, + "defaultMsgVpnAccessLevelExceptionsUri": { + "description": "The URI of this OAuth Profile's collection of Message VPN Access-Level Exception objects.", + "type": "string" + }, + "resourceServerRequiredClaimsUri": { + "description": "The URI of this OAuth Profile's collection of Required Claim objects.", "type": "string" }, "uri": { - "description": "The URI of this Group Access Level object.", + "description": "The URI of this OAuth Profile object.", "type": "string" } }, "type": "object" }, - "OauthProfileAccessLevelGroupMsgVpnAccessLevelException": { + "OauthProfileResourceServerRequiredClaim": { "properties": { - "accessLevel": { - "description": "The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", - "enum": [ - "none", - "read-only", - "read-write" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "none", - "x-configSyncTableType": "router", - "x-default": "none", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "groupName": { - "description": "The name of the group.", - "maxLength": 64, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "maxLength": 32, "minLength": 1, + "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-accessLevels": { "get": "global/read-only" @@ -34671,11 +33350,10 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the message VPN.", - "maxLength": 32, + "resourceServerRequiredClaimName": { + "description": "The name of the access token claim to verify.", + "maxLength": 100, "minLength": 1, - "pattern": "^[^*?]+$", "type": "string", "x-accessLevels": { "get": "global/read-only" @@ -34692,51 +33370,50 @@ "x-requiresDisable": [], "x-writeOnly": false }, - "oauthProfileName": { - "description": "The name of the OAuth profile.", - "maxLength": 32, + "resourceServerRequiredClaimValue": { + "description": "The required claim value, which must be a string containing a valid JSON value.", + "maxLength": 200, "minLength": 1, - "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-accessLevels": { "get": "global/read-only" }, "x-autoDisable": [], "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": true, - "x-readOnlyPost": true, + "x-readOnlyPost": false, "x-readOptional": false, - "x-requiredPost": false, + "x-requiredPost": true, "x-requiresDisable": [], "x-writeOnly": false } }, "type": "object", "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" + "delete": "global/admin", + "post": "global/admin" }, "x-configSyncTableTypeCreateDelete": "router" }, - "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks": { + "OauthProfileResourceServerRequiredClaimLinks": { "properties": { "uri": { - "description": "The URI of this Message VPN Access-Level Exception object.", + "description": "The URI of this Required Claim object.", "type": "string" } }, "type": "object" }, - "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse": { + "OauthProfileResourceServerRequiredClaimResponse": { "properties": { "data": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaim" }, "links": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks" + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -34747,17 +33424,17 @@ ], "type": "object" }, - "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse": { + "OauthProfileResourceServerRequiredClaimsResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaim" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks" + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimLinks" }, "type": "array" }, @@ -34770,13 +33447,13 @@ ], "type": "object" }, - "OauthProfileAccessLevelGroupResponse": { + "OauthProfileResponse": { "properties": { "data": { - "$ref": "#/definitions/OauthProfileAccessLevelGroup" + "$ref": "#/definitions/OauthProfile" }, "links": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupLinks" + "$ref": "#/definitions/OauthProfileLinks" }, "meta": { "$ref": "#/definitions/SempMeta" @@ -34787,17 +33464,17 @@ ], "type": "object" }, - "OauthProfileAccessLevelGroupsResponse": { + "OauthProfilesResponse": { "properties": { "data": { "items": { - "$ref": "#/definitions/OauthProfileAccessLevelGroup" + "$ref": "#/definitions/OauthProfile" }, "type": "array" }, "links": { "items": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupLinks" + "$ref": "#/definitions/OauthProfileLinks" }, "type": "array" }, @@ -34810,74 +33487,59 @@ ], "type": "object" }, - "OauthProfileClientAllowedHost": { + "SempError": { "properties": { - "allowedHost": { - "description": "An allowed value for the Host header.", - "maxLength": 255, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false + "code": { + "description": "The error code which uniquely identifies the error that has occurred.", + "format": "int32", + "type": "integer" }, - "oauthProfileName": { - "description": "The name of the OAuth profile.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[A-Za-z0-9_]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false + "description": { + "description": "The verbose description of the problem.", + "type": "string" + }, + "status": { + "description": "The terse status string associated with `code`.", + "type": "string" } }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" + "required": [ + "code", + "status", + "description" + ], + "type": "object" }, - "OauthProfileClientAllowedHostLinks": { + "SempMeta": { "properties": { - "uri": { - "description": "The URI of this Allowed Host Value object.", - "type": "string" + "count": { + "description": "The total number of objects requested, irrespective of page size. This may be a count of all objects in a collection or a filtered subset. It represents a snapshot in time and may change when paging through results.", + "format": "int64", + "type": "integer" + }, + "error": { + "$ref": "#/definitions/SempError" + }, + "paging": { + "$ref": "#/definitions/SempPaging" + }, + "request": { + "$ref": "#/definitions/SempRequest" + }, + "responseCode": { + "description": "The HTTP response code, one of 200 (success), 4xx (client error), or 5xx (server error).", + "format": "int32", + "type": "integer" } }, + "required": [ + "request", + "responseCode" + ], "type": "object" }, - "OauthProfileClientAllowedHostResponse": { + "SempMetaOnlyResponse": { "properties": { - "data": { - "$ref": "#/definitions/OauthProfileClientAllowedHost" - }, - "links": { - "$ref": "#/definitions/OauthProfileClientAllowedHostLinks" - }, "meta": { "$ref": "#/definitions/SempMeta" } @@ -34887,743 +33549,353 @@ ], "type": "object" }, - "OauthProfileClientAllowedHostsResponse": { + "SempPaging": { "properties": { - "data": { - "items": { - "$ref": "#/definitions/OauthProfileClientAllowedHost" - }, - "type": "array" + "cursorQuery": { + "description": "The cursor, or position, for the next page of objects. Use this as the `cursor` query parameter of the next request.", + "type": "string" }, - "links": { - "items": { - "$ref": "#/definitions/OauthProfileClientAllowedHostLinks" - }, - "type": "array" + "nextPageUri": { + "description": "The URI of the next page of objects. `cursorQuery` is already embedded within this URI.", + "type": "string" + } + }, + "required": [ + "cursorQuery", + "nextPageUri" + ], + "type": "object" + }, + "SempRequest": { + "properties": { + "method": { + "description": "The HTTP method of the request which resulted in this response.", + "type": "string" }, - "meta": { - "$ref": "#/definitions/SempMeta" + "uri": { + "description": "The URI of the request which resulted in this response. The URI may be normalized.", + "type": "string" } }, "required": [ - "meta" + "method" ], "type": "object" }, - "OauthProfileClientAuthorizationParameter": { + "ServiceEventConnectionCountThreshold": { + "description": "The thresholds for the connection count event. Available since 2.17.", "properties": { - "authorizationParameterName": { - "description": "The name of the authorization parameter.", - "maxLength": 32, - "minLength": 1, - "type": "string", + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "global/read-only" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 60, + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "authorizationParameterValue": { - "description": "The authorization parameter value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 255, - "minLength": 0, - "type": "string", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 200000, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "global/read-only", - "patch": "global/admin" + "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "", "x-configSyncTableType": "router", - "x-default": "", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "oauthProfileName": { - "description": "The name of the OAuth profile.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[A-Za-z0-9_]+$", - "type": "string", + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "global/read-only" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 80, + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "OauthProfileClientAuthorizationParameterLinks": { - "properties": { - "uri": { - "description": "The URI of this Authorization Parameter object.", - "type": "string" - } - }, - "type": "object" - }, - "OauthProfileClientAuthorizationParameterResponse": { - "properties": { - "data": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" - }, - "links": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameterLinks" }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfileClientAuthorizationParametersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameterLinks" + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 200000, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" + "x-autoDisable": [], + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false } }, - "required": [ - "meta" - ], "type": "object" }, - "OauthProfileClientRequiredClaim": { + "ServiceRestEventOutgoingConnectionCountThreshold": { + "description": "The thresholds for the REST outgoing connection count event. Available since 2.17.", "properties": { - "clientRequiredClaimName": { - "description": "The name of the ID token claim to verify.", - "maxLength": 100, - "minLength": 1, - "type": "string", + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "global/read-only" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 60, + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "clientRequiredClaimValue": { - "description": "The required claim value, which must be a string containing a valid JSON value.", - "maxLength": 200, - "minLength": 1, - "type": "string", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 6000, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "global/read-only" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, + "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "setValue" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "oauthProfileName": { - "description": "The name of the OAuth profile.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[A-Za-z0-9_]+$", - "type": "string", + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "global/read-only" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 80, + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 80, "x-deprecated": false, - "x-identifying": true, + "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "clearPercent" + ], "x-requiresDisable": [], "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "OauthProfileClientRequiredClaimLinks": { - "properties": { - "uri": { - "description": "The URI of this Required Claim object.", - "type": "string" - } - }, - "type": "object" - }, - "OauthProfileClientRequiredClaimResponse": { - "properties": { - "data": { - "$ref": "#/definitions/OauthProfileClientRequiredClaim" - }, - "links": { - "$ref": "#/definitions/OauthProfileClientRequiredClaimLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfileClientRequiredClaimsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/OauthProfileClientRequiredClaim" - }, - "type": "array" }, - "links": { - "items": { - "$ref": "#/definitions/OauthProfileClientRequiredClaimLinks" + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 6000, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" + "x-autoDisable": [], + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "clearValue" + ], + "x-requiresDisable": [], + "x-writeOnly": false } }, - "required": [ - "meta" - ], "type": "object" }, - "OauthProfileDefaultMsgVpnAccessLevelException": { + "ServiceSmfEventConnectionCountThreshold": { + "description": "The thresholds for the SMF connection count event. Available since 2.17.", "properties": { - "accessLevel": { - "description": "The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", - "enum": [ - "none", - "read-only", - "read-write" - ], - "type": "string", + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 100, + "minimum": 0, + "type": "integer", "x-accessLevels": { "get": "global/read-only", "patch": "global/read-write" }, "x-autoDisable": [], - "x-configSyncDefault": "none", + "x-configSyncDefault": 60, "x-configSyncTableType": "router", - "x-default": "none", + "x-conflicts": [ + "clearValue", + "setValue" + ], + "x-default": 60, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, + "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "setPercent" + ], "x-requiresDisable": [], "x-writeOnly": false }, - "msgVpnName": { - "description": "The name of the message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "maximum": 200000, + "minimum": 0, + "type": "integer", "x-accessLevels": { - "get": "global/read-only" + "get": "global/read-only", + "patch": "global/read-write" }, "x-autoDisable": [], + "x-configSyncTableType": "router", + "x-conflicts": [ + "clearPercent", + "setPercent" + ], "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "oauthProfileName": { - "description": "The name of the OAuth profile.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[A-Za-z0-9_]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "OauthProfileDefaultMsgVpnAccessLevelExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Message VPN Access-Level Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "OauthProfileDefaultMsgVpnAccessLevelExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" - }, - "links": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfileLinks": { - "properties": { - "accessLevelGroupsUri": { - "description": "The URI of this OAuth Profile's collection of Group Access Level objects.", - "type": "string" - }, - "clientAllowedHostsUri": { - "description": "The URI of this OAuth Profile's collection of Allowed Host Value objects.", - "type": "string" - }, - "clientAuthorizationParametersUri": { - "description": "The URI of this OAuth Profile's collection of Authorization Parameter objects.", - "type": "string" - }, - "clientRequiredClaimsUri": { - "description": "The URI of this OAuth Profile's collection of Required Claim objects.", - "type": "string" - }, - "defaultMsgVpnAccessLevelExceptionsUri": { - "description": "The URI of this OAuth Profile's collection of Message VPN Access-Level Exception objects.", - "type": "string" - }, - "resourceServerRequiredClaimsUri": { - "description": "The URI of this OAuth Profile's collection of Required Claim objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this OAuth Profile object.", - "type": "string" - } - }, - "type": "object" - }, - "OauthProfileResourceServerRequiredClaim": { - "properties": { - "oauthProfileName": { - "description": "The name of the OAuth profile.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[A-Za-z0-9_]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerRequiredClaimName": { - "description": "The name of the access token claim to verify.", - "maxLength": 100, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": true, - "x-identifyingDirect": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "resourceServerRequiredClaimValue": { - "description": "The required claim value, which must be a string containing a valid JSON value.", - "maxLength": 200, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "OauthProfileResourceServerRequiredClaimLinks": { - "properties": { - "uri": { - "description": "The URI of this Required Claim object.", - "type": "string" - } - }, - "type": "object" - }, - "OauthProfileResourceServerRequiredClaimResponse": { - "properties": { - "data": { - "$ref": "#/definitions/OauthProfileResourceServerRequiredClaim" - }, - "links": { - "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfileResourceServerRequiredClaimsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/OauthProfileResourceServerRequiredClaim" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfileResponse": { - "properties": { - "data": { - "$ref": "#/definitions/OauthProfile" - }, - "links": { - "$ref": "#/definitions/OauthProfileLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfilesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/OauthProfile" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/OauthProfileLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "SempError": { - "properties": { - "code": { - "description": "The error code which uniquely identifies the error that has occurred.", - "format": "int32", - "type": "integer" - }, - "description": { - "description": "The verbose description of the problem.", - "type": "string" - }, - "status": { - "description": "The terse status string associated with `code`.", - "type": "string" - } - }, - "required": [ - "code", - "status", - "description" - ], - "type": "object" - }, - "SempMeta": { - "properties": { - "count": { - "description": "The total number of objects requested, irrespective of page size. This may be a count of all objects in a collection or a filtered subset. It represents a snapshot in time and may change when paging through results.", - "format": "int64", - "type": "integer" - }, - "error": { - "$ref": "#/definitions/SempError" - }, - "paging": { - "$ref": "#/definitions/SempPaging" - }, - "request": { - "$ref": "#/definitions/SempRequest" - }, - "responseCode": { - "description": "The HTTP response code, one of 200 (success), 4xx (client error), or 5xx (server error).", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "request", - "responseCode" - ], - "type": "object" - }, - "SempMetaOnlyResponse": { - "properties": { - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "SempPaging": { - "properties": { - "cursorQuery": { - "description": "The cursor, or position, for the next page of objects. Use this as the `cursor` query parameter of the next request.", - "type": "string" - }, - "nextPageUri": { - "description": "The URI of the next page of objects. `cursorQuery` is already embedded within this URI.", - "type": "string" - } - }, - "required": [ - "cursorQuery", - "nextPageUri" - ], - "type": "object" - }, - "SempRequest": { - "properties": { - "method": { - "description": "The HTTP method of the request which resulted in this response.", - "type": "string" - }, - "uri": { - "description": "The URI of the request which resulted in this response. The URI may be normalized.", - "type": "string" - } - }, - "required": [ - "method" - ], - "type": "object" - }, - "ServiceEventConnectionCountThreshold": { - "description": "The thresholds for the connection count event. Available since 2.17.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, + "x-identifying": false, + "x-identifyingDirect": false, "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, @@ -35700,8 +33972,8 @@ }, "type": "object" }, - "ServiceRestEventOutgoingConnectionCountThreshold": { - "description": "The thresholds for the REST outgoing connection count event. Available since 2.17.", + "ServiceTlsEventConnectionCountThreshold": { + "description": "The thresholds for the incoming and outgoing TLS connection count event of the broker. Available since 2.17.", "properties": { "clearPercent": { "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", @@ -35738,7 +34010,7 @@ "clearValue": { "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 6000, + "maximum": 200000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -35800,7 +34072,7 @@ "setValue": { "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", "format": "int64", - "maximum": 6000, + "maximum": 200000, "minimum": 0, "type": "integer", "x-accessLevels": { @@ -35830,304 +34102,44 @@ }, "type": "object" }, - "ServiceSmfEventConnectionCountThreshold": { - "description": "The thresholds for the SMF connection count event. Available since 2.17.", + "SystemInformation": { "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", + "platform": { + "description": "The platform running the SEMP API. Deprecated since 2.4. /systemInformation was replaced by /about/api.", + "maxLength": 10, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" + "get": "global/none" }, "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, - "x-deprecated": false, + "x-deprecated": true, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], "x-requiresDisable": [], "x-writeOnly": false }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", + "sempVersion": { + "description": "The version of the SEMP API. Deprecated since 2.4. /systemInformation was replaced by /about/api.", + "maxLength": 10, + "minLength": 0, + "type": "string", "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" + "get": "global/none" }, "x-autoDisable": [], - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, + "x-deprecated": true, "x-identifying": false, "x-identifyingDirect": false, "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "ServiceTlsEventConnectionCountThreshold": { - "description": "The thresholds for the incoming and outgoing TLS connection count event of the broker. Available since 2.17.", - "properties": { - "clearPercent": { - "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 60, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "clearValue": { - "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setPercent": { - "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearValue", - "setValue" - ], - "x-default": 80, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "router", - "x-conflicts": [ - "clearPercent", - "setPercent" - ], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "SystemInformation": { - "properties": { - "platform": { - "description": "The platform running the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api.", - "maxLength": 10, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": true, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "sempVersion": { - "description": "The version of the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api.", - "maxLength": 10, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": true, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], "x-writeOnly": false @@ -36362,809 +34374,16 @@ } }, "paths": { - "/": { - "get": { - "description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Opaque\n:---|:---:|:---:\ntlsServerCertContent|x|x\ntlsServerCertPassword|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/read-only\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-only\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-only\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-only\nconfigSyncClientProfileTcpKeepaliveCount|global/read-only\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-only\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-only\nconfigSyncClientProfileTcpMaxWindow|global/read-only\nconfigSyncClientProfileTcpMss|global/read-only\nconfigSyncEnabled|global/read-only\nconfigSyncSynchronizeUsernameEnabled|global/read-only\nconfigSyncTlsEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleDayList|global/read-only\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-only\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-only\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-only\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only\nguaranteedMsgingEnabled|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only\nguaranteedMsgingMaxCacheUsage|global/read-only\nguaranteedMsgingMaxMsgSpoolUsage|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only\noauthProfileDefault|global/read-only\nserviceAmqpEnabled|global/read-only\nserviceAmqpTlsListenPort|global/read-only\nserviceEventConnectionCountThreshold.clearPercent|global/read-only\nserviceEventConnectionCountThreshold.clearValue|global/read-only\nserviceEventConnectionCountThreshold.setPercent|global/read-only\nserviceEventConnectionCountThreshold.setValue|global/read-only\nserviceHealthCheckEnabled|global/read-only\nserviceHealthCheckListenPort|global/read-only\nserviceHealthCheckTlsEnabled|global/read-only\nserviceHealthCheckTlsListenPort|global/read-only\nserviceMateLinkEnabled|global/read-only\nserviceMateLinkListenPort|global/read-only\nserviceMqttEnabled|global/read-only\nserviceMsgBackboneEnabled|global/read-only\nserviceRedundancyEnabled|global/read-only\nserviceRedundancyFirstListenPort|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only\nserviceRestIncomingEnabled|global/read-only\nserviceRestOutgoingEnabled|global/read-only\nserviceSempCorsAllowAnyHostEnabled|global/read-only\nserviceSempLegacyTimeoutEnabled|global/read-only\nserviceSempPlainTextEnabled|global/read-only\nserviceSempPlainTextListenPort|global/read-only\nserviceSempSessionIdleTimeout|global/read-only\nserviceSempSessionMaxLifetime|global/read-only\nserviceSempTlsEnabled|global/read-only\nserviceSempTlsListenPort|global/read-only\nserviceSmfCompressionListenPort|global/read-only\nserviceSmfEnabled|global/read-only\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-only\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.setValue|global/read-only\nserviceSmfPlainTextListenPort|global/read-only\nserviceSmfRoutingControlListenPort|global/read-only\nserviceSmfTlsListenPort|global/read-only\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-only\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.setValue|global/read-only\nserviceWebTransportEnabled|global/read-only\nserviceWebTransportPlainTextListenPort|global/read-only\nserviceWebTransportTlsListenPort|global/read-only\nserviceWebTransportWebUrlSuffix|global/read-only\ntlsBlockVersion11Enabled|global/read-only\ntlsCipherSuiteManagementList|global/read-only\ntlsCipherSuiteMsgBackboneList|global/read-only\ntlsCipherSuiteSecureShellList|global/read-only\ntlsCrimeExploitProtectionEnabled|global/read-only\ntlsServerCertContent|global/read-only\ntlsTicketLifetime|global/read-only\n\n\n\nThis has been available since 2.13.", - "operationId": "getBroker", - "parameters": [ - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Broker object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/BrokerResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Broker object.", - "tags": [ - "all" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Broker object. Any attribute missing from the request will be left unchanged.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Requires-Disable|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:\nserviceAmqpTlsListenPort|||x|\nserviceHealthCheckListenPort|||x|\nserviceHealthCheckTlsListenPort|||x|\nserviceMateLinkListenPort|||x|\nserviceRedundancyFirstListenPort|||x|\nserviceSempPlainTextListenPort||x||\nserviceSempTlsListenPort||x||\nserviceSmfCompressionListenPort|||x|\nserviceSmfPlainTextListenPort|||x|\nserviceSmfRoutingControlListenPort|||x|\nserviceSmfTlsListenPort|||x|\nserviceWebTransportPlainTextListenPort|||x|\nserviceWebTransportTlsListenPort|||x|\nserviceWebTransportWebUrlSuffix|||x|\ntlsServerCertContent|x|||x\ntlsServerCertPassword|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nBroker|tlsServerCertPassword|tlsServerCertContent|\nGuaranteedMsgingEventCacheUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventCacheUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventDeliveredUnackedThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDeliveredUnackedThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventDiskUsageThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDiskUsageThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/admin\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-write\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-write\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-write\nconfigSyncClientProfileTcpKeepaliveCount|global/read-write\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-write\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-write\nconfigSyncClientProfileTcpMaxWindow|global/read-write\nconfigSyncClientProfileTcpMss|global/read-write\nconfigSyncEnabled|global/read-write\nconfigSyncSynchronizeUsernameEnabled|global/read-write\nconfigSyncTlsEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleDayList|global/read-write\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-write\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-write\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-write\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write\nguaranteedMsgingEnabled|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write\nguaranteedMsgingMaxCacheUsage|global/read-write\nguaranteedMsgingMaxMsgSpoolUsage|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write\noauthProfileDefault|global/admin\nserviceAmqpEnabled|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceEventConnectionCountThreshold.clearPercent|global/read-write\nserviceEventConnectionCountThreshold.clearValue|global/read-write\nserviceEventConnectionCountThreshold.setPercent|global/read-write\nserviceEventConnectionCountThreshold.setValue|global/read-write\nserviceHealthCheckEnabled|global/read-write\nserviceHealthCheckListenPort|global/read-write\nserviceHealthCheckTlsEnabled|global/read-write\nserviceHealthCheckTlsListenPort|global/read-write\nserviceMateLinkEnabled|global/read-write\nserviceMateLinkListenPort|global/read-write\nserviceMqttEnabled|global/read-write\nserviceMsgBackboneEnabled|global/read-write\nserviceRedundancyEnabled|global/read-write\nserviceRedundancyFirstListenPort|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write\nserviceRestIncomingEnabled|global/read-write\nserviceRestOutgoingEnabled|global/read-write\nserviceSempCorsAllowAnyHostEnabled|global/read-write\nserviceSempLegacyTimeoutEnabled|global/read-write\nserviceSempPlainTextEnabled|global/read-write\nserviceSempPlainTextListenPort|global/read-write\nserviceSempSessionIdleTimeout|global/read-write\nserviceSempSessionMaxLifetime|global/read-write\nserviceSempTlsEnabled|global/read-write\nserviceSempTlsListenPort|global/read-write\nserviceSmfCompressionListenPort|global/read-write\nserviceSmfEnabled|global/read-write\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-write\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.setValue|global/read-write\nserviceSmfPlainTextListenPort|global/read-write\nserviceSmfRoutingControlListenPort|global/read-write\nserviceSmfTlsListenPort|global/read-write\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-write\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.setValue|global/read-write\nserviceWebTransportEnabled|global/read-write\nserviceWebTransportPlainTextListenPort|global/read-write\nserviceWebTransportTlsListenPort|global/read-write\nserviceWebTransportWebUrlSuffix|global/read-write\ntlsBlockVersion11Enabled|global/read-write\ntlsCipherSuiteManagementList|global/read-write\ntlsCipherSuiteMsgBackboneList|global/read-write\ntlsCipherSuiteSecureShellList|global/read-write\ntlsCrimeExploitProtectionEnabled|global/read-write\ntlsServerCertContent|global/admin\ntlsServerCertPassword|global/admin\ntlsStandardDomainCertificateAuthoritiesEnabled|global/read-write\ntlsTicketLifetime|global/read-write\nwebManagerAllowUnencryptedWizardsEnabled|global/read-write\nwebManagerRedirectHttpEnabled|global/read-write\nwebManagerRedirectHttpOverrideTlsPort|global/read-write\n\n\n\nThis has been available since 2.13.", - "operationId": "updateBroker", - "parameters": [ - { - "description": "The Broker object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Broker" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Broker object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/BrokerResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Broker object.", - "tags": [ - "all" - ], - "x-supportedInSempDirect": false - } - }, - "/about": { - "get": { - "description": "Get an About object.\n\nThis provides metadata about the SEMP API, such as the version of the API supported by the broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.13.", - "operationId": "getAbout", - "parameters": [ - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The About object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/AboutResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an About object.", - "tags": [ - "all", - "about" - ], - "x-supportedInSempDirect": false - } - }, - "/about/api": { - "get": { - "description": "Get an API Description object.\n\nThe API Description object provides metadata about the SEMP API.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "getAboutApi", - "parameters": [ - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The API Description object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/AboutApiResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an API Description object.", - "tags": [ - "all", - "about" - ], - "x-supportedInSempDirect": false - } - }, - "/about/user": { - "get": { - "description": "Get a User object.\n\nSession and access level information about the user accessing the SEMP API.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "getAboutUser", - "parameters": [ - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The User object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/AboutUserResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a User object.", - "tags": [ - "all", - "about" - ], - "x-supportedInSempDirect": false - } - }, - "/about/user/msgVpns": { - "get": { - "description": "Get a list of User Message VPN objects.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", - "operationId": "getAboutUserMsgVpns", - "parameters": [ - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of User Message VPN objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/AboutUserMsgVpnsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of User Message VPN objects.", - "tags": [ - "all", - "about" - ], - "x-supportedInSempDirect": false - } - }, - "/about/user/msgVpns/{msgVpnName}": { - "get": { - "description": "Get a User Message VPN object.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "getAboutUserMsgVpn", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The User Message VPN object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/AboutUserMsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a User Message VPN object.", - "tags": [ - "all", - "about" - ], - "x-supportedInSempDirect": false - } - }, - "/certAuthorities": { - "get": { - "deprecated": true, - "description": "Get a list of Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\ncertContent||x\ncrlDayList||x\ncrlTimeList||x\ncrlUrl||x\nocspNonResponderCertEnabled||x\nocspOverrideUrl||x\nocspTimeout||x\nrevocationCheckEnabled||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "operationId": "getCertAuthorities", - "parameters": [ - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Certificate Authority objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthoritiesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Certificate Authority objects.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - }, - "post": { - "deprecated": true, - "description": "Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|x|x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl||||x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "operationId": "createCertAuthority", - "parameters": [ - { - "description": "The Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CertAuthority" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Authority object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Certificate Authority object.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - } - }, - "/certAuthorities/{certAuthorityName}": { - "delete": { - "deprecated": true, - "description": "Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "operationId": "deleteCertAuthority", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete a Certificate Authority object.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - }, - "get": { - "deprecated": true, - "description": "Get a Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\ncertContent||x\ncrlDayList||x\ncrlTimeList||x\ncrlUrl||x\nocspNonResponderCertEnabled||x\nocspOverrideUrl||x\nocspTimeout||x\nrevocationCheckEnabled||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "operationId": "getCertAuthority", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Authority object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Certificate Authority object.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "deprecated": true, - "description": "Update a Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl|||x|x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "operationId": "updateCertAuthority", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CertAuthority" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Authority object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Certificate Authority object.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - }, - "put": { - "deprecated": true, - "description": "Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl|||x|x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "operationId": "replaceCertAuthority", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CertAuthority" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Authority object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Certificate Authority object.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - } - }, - "/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { - "get": { - "deprecated": true, - "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\nocspTlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", - "operationId": "getCertAuthorityOcspTlsTrustedCommonNames", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNamesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of OCSP Responder Trusted Common Name objects.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - }, - "post": { - "deprecated": true, - "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x|x\nocspTlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", - "operationId": "createCertAuthorityOcspTlsTrustedCommonName", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "description": "The OCSP Responder Trusted Common Name object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonName" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an OCSP Responder Trusted Common Name object.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - } - }, - "/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}": { - "delete": { - "deprecated": true, - "description": "Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", - "operationId": "deleteCertAuthorityOcspTlsTrustedCommonName", + "/": { + "get": { + "description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Opaque\n:---|:---:|:---:\ntlsServerCertContent|x|x\ntlsServerCertPassword|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/read-only\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-only\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-only\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-only\nconfigSyncClientProfileTcpKeepaliveCount|global/read-only\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-only\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-only\nconfigSyncClientProfileTcpMaxWindow|global/read-only\nconfigSyncClientProfileTcpMss|global/read-only\nconfigSyncEnabled|global/read-only\nconfigSyncSynchronizeUsernameEnabled|global/read-only\nconfigSyncTlsEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleDayList|global/read-only\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-only\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-only\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-only\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only\nguaranteedMsgingDiskArrayWwn|global/read-only\nguaranteedMsgingDiskLocation|global/read-only\nguaranteedMsgingEnabled|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only\nguaranteedMsgingMaxCacheUsage|global/read-only\nguaranteedMsgingMaxMsgSpoolUsage|global/read-only\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only\nguaranteedMsgingVirtualRouterWhenActiveActive|global/read-only\noauthProfileDefault|global/read-only\nserviceAmqpEnabled|global/read-only\nserviceAmqpTlsListenPort|global/read-only\nserviceEventConnectionCountThreshold.clearPercent|global/read-only\nserviceEventConnectionCountThreshold.clearValue|global/read-only\nserviceEventConnectionCountThreshold.setPercent|global/read-only\nserviceEventConnectionCountThreshold.setValue|global/read-only\nserviceHealthCheckEnabled|global/read-only\nserviceHealthCheckListenPort|global/read-only\nserviceHealthCheckTlsEnabled|global/read-only\nserviceHealthCheckTlsListenPort|global/read-only\nserviceMqttEnabled|global/read-only\nserviceMsgBackboneEnabled|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only\nserviceRestIncomingEnabled|global/read-only\nserviceRestOutgoingEnabled|global/read-only\nserviceSempCorsAllowAnyHostEnabled|global/read-only\nserviceSempLegacyTimeoutEnabled|global/read-only\nserviceSempPlainTextEnabled|global/read-only\nserviceSempPlainTextListenPort|global/read-only\nserviceSempSessionIdleTimeout|global/read-only\nserviceSempSessionMaxLifetime|global/read-only\nserviceSempTlsEnabled|global/read-only\nserviceSempTlsListenPort|global/read-only\nserviceSmfCompressionListenPort|global/read-only\nserviceSmfEnabled|global/read-only\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-only\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.setValue|global/read-only\nserviceSmfPlainTextListenPort|global/read-only\nserviceSmfRoutingControlListenPort|global/read-only\nserviceSmfTlsListenPort|global/read-only\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-only\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.setValue|global/read-only\nserviceWebTransportEnabled|global/read-only\nserviceWebTransportPlainTextListenPort|global/read-only\nserviceWebTransportTlsListenPort|global/read-only\nserviceWebTransportWebUrlSuffix|global/read-only\ntlsBlockVersion10Enabled|global/read-only\ntlsBlockVersion11Enabled|global/read-only\ntlsCipherSuiteManagementList|global/read-only\ntlsCipherSuiteMsgBackboneList|global/read-only\ntlsCipherSuiteSecureShellList|global/read-only\ntlsCrimeExploitProtectionEnabled|global/read-only\ntlsServerCertContent|global/read-only\ntlsTicketLifetime|global/read-only\n\n\n\nThis has been available since 2.13.", + "operationId": "getBroker", "parameters": [ { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" + "$ref": "#/parameters/opaquePasswordQuery" }, { - "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", - "in": "path", - "name": "ocspTlsTrustedCommonName", - "required": true, - "type": "string" + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -37175,9 +34394,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The Broker object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/BrokerResponse" } }, "default": { @@ -37192,31 +34411,24 @@ "basicAuth": [] } ], - "summary": "Delete an OCSP Responder Trusted Common Name object.", + "summary": "Get a Broker object.", "tags": [ - "all", - "certAuthority" + "all" ], "x-supportedInSempDirect": false }, - "get": { - "deprecated": true, - "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\nocspTlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", - "operationId": "getCertAuthorityOcspTlsTrustedCommonName", + "patch": { + "description": "Update a Broker object. Any attribute missing from the request will be left unchanged.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Requires-Disable|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:\nguaranteedMsgingDiskLocation|||x|\nguaranteedMsgingVirtualRouterWhenActiveActive|||x|\nserviceAmqpTlsListenPort|||x|\nserviceHealthCheckListenPort|||x|\nserviceHealthCheckTlsListenPort|||x|\nserviceSempPlainTextListenPort||x||\nserviceSempTlsListenPort||x||\nserviceSmfCompressionListenPort|||x|\nserviceSmfPlainTextListenPort|||x|\nserviceSmfRoutingControlListenPort|||x|\nserviceSmfTlsListenPort|||x|\nserviceWebTransportPlainTextListenPort|||x|\nserviceWebTransportTlsListenPort|||x|\nserviceWebTransportWebUrlSuffix|||x|\ntlsServerCertContent|x|||x\ntlsServerCertPassword|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nBroker|tlsServerCertPassword|tlsServerCertContent|\nGuaranteedMsgingEventCacheUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventCacheUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventDeliveredUnackedThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDeliveredUnackedThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventDiskUsageThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDiskUsageThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/admin\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-write\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-write\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-write\nconfigSyncClientProfileTcpKeepaliveCount|global/read-write\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-write\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-write\nconfigSyncClientProfileTcpMaxWindow|global/read-write\nconfigSyncClientProfileTcpMss|global/read-write\nconfigSyncEnabled|global/read-write\nconfigSyncSynchronizeUsernameEnabled|global/read-write\nconfigSyncTlsEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleDayList|global/read-write\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-write\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-write\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-write\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write\nguaranteedMsgingDiskArrayWwn|global/read-write\nguaranteedMsgingDiskLocation|global/read-write\nguaranteedMsgingEnabled|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write\nguaranteedMsgingMaxCacheUsage|global/read-write\nguaranteedMsgingMaxMsgSpoolUsage|global/read-write\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write\nguaranteedMsgingVirtualRouterWhenActiveActive|global/read-write\noauthProfileDefault|global/admin\nserviceAmqpEnabled|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceEventConnectionCountThreshold.clearPercent|global/read-write\nserviceEventConnectionCountThreshold.clearValue|global/read-write\nserviceEventConnectionCountThreshold.setPercent|global/read-write\nserviceEventConnectionCountThreshold.setValue|global/read-write\nserviceHealthCheckEnabled|global/read-write\nserviceHealthCheckListenPort|global/read-write\nserviceHealthCheckTlsEnabled|global/read-write\nserviceHealthCheckTlsListenPort|global/read-write\nserviceMqttEnabled|global/read-write\nserviceMsgBackboneEnabled|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write\nserviceRestIncomingEnabled|global/read-write\nserviceRestOutgoingEnabled|global/read-write\nserviceSempCorsAllowAnyHostEnabled|global/read-write\nserviceSempLegacyTimeoutEnabled|global/read-write\nserviceSempPlainTextEnabled|global/read-write\nserviceSempPlainTextListenPort|global/read-write\nserviceSempSessionIdleTimeout|global/read-write\nserviceSempSessionMaxLifetime|global/read-write\nserviceSempTlsEnabled|global/read-write\nserviceSempTlsListenPort|global/read-write\nserviceSmfCompressionListenPort|global/read-write\nserviceSmfEnabled|global/read-write\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-write\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.setValue|global/read-write\nserviceSmfPlainTextListenPort|global/read-write\nserviceSmfRoutingControlListenPort|global/read-write\nserviceSmfTlsListenPort|global/read-write\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-write\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.setValue|global/read-write\nserviceWebTransportEnabled|global/read-write\nserviceWebTransportPlainTextListenPort|global/read-write\nserviceWebTransportTlsListenPort|global/read-write\nserviceWebTransportWebUrlSuffix|global/read-write\ntlsBlockVersion10Enabled|global/read-write\ntlsBlockVersion11Enabled|global/read-write\ntlsCipherSuiteManagementList|global/read-write\ntlsCipherSuiteMsgBackboneList|global/read-write\ntlsCipherSuiteSecureShellList|global/read-write\ntlsCrimeExploitProtectionEnabled|global/read-write\ntlsServerCertContent|global/admin\ntlsServerCertPassword|global/admin\ntlsStandardDomainCertificateAuthoritiesEnabled|global/read-write\ntlsTicketLifetime|global/read-write\nwebManagerAllowUnencryptedWizardsEnabled|global/read-write\nwebManagerRedirectHttpEnabled|global/read-write\nwebManagerRedirectHttpOverrideTlsPort|global/read-write\n\n\n\nThis has been available since 2.13.", + "operationId": "updateBroker", "parameters": [ { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", - "in": "path", - "name": "ocspTlsTrustedCommonName", + "description": "The Broker object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/Broker" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -37233,9 +34445,9 @@ ], "responses": { "200": { - "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", + "description": "The Broker object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameResponse" + "$ref": "#/definitions/BrokerResponse" } }, "default": { @@ -37250,34 +34462,21 @@ "basicAuth": [] } ], - "summary": "Get an OCSP Responder Trusted Common Name object.", + "summary": "Update a Broker object.", "tags": [ - "all", - "certAuthority" + "all" ], "x-supportedInSempDirect": false } }, - "/clientCertAuthorities": { + "/about": { "get": { - "description": "Get a list of Client Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", - "operationId": "getClientCertAuthorities", + "description": "Get an About object.\n\nThis provides metadata about the SEMP API, such as the version of the API supported by the broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.13.", + "operationId": "getAbout", "parameters": [ - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -37290,9 +34489,9 @@ ], "responses": { "200": { - "description": "The list of Client Certificate Authority objects' attributes, and the request metadata.", + "description": "The About object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthoritiesResponse" + "$ref": "#/definitions/AboutResponse" } }, "default": { @@ -37307,26 +34506,19 @@ "basicAuth": [] } ], - "summary": "Get a list of Client Certificate Authority objects.", + "summary": "Get an About object.", "tags": [ "all", - "clientCertAuthority" + "about" ], "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "createClientCertAuthority", + } + }, + "/about/api": { + "get": { + "description": "Get an API Description object.\n\nThe API Description object provides metadata about the SEMP API.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "getAboutApi", "parameters": [ - { - "description": "The Client Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClientCertAuthority" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -37342,9 +34534,9 @@ ], "responses": { "200": { - "description": "The Client Certificate Authority object's attributes after being created, and the request metadata.", + "description": "The API Description object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" + "$ref": "#/definitions/AboutApiResponse" } }, "default": { @@ -37359,70 +34551,19 @@ "basicAuth": [] } ], - "summary": "Create a Client Certificate Authority object.", + "summary": "Get an API Description object.", "tags": [ "all", - "clientCertAuthority" + "about" ], "x-supportedInSempDirect": false } }, - "/clientCertAuthorities/{certAuthorityName}": { - "delete": { - "description": "Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "deleteClientCertAuthority", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete a Client Certificate Authority object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "x-supportedInSempDirect": false - }, + "/about/user": { "get": { - "description": "Get a Client Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "getClientCertAuthority", + "description": "Get a User object.\n\nSession and access level information about the user accessing the SEMP API.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "getAboutUser", "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -37438,9 +34579,9 @@ ], "responses": { "200": { - "description": "The Client Certificate Authority object's attributes, and the request metadata.", + "description": "The User object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" + "$ref": "#/definitions/AboutUserResponse" } }, "default": { @@ -37455,36 +34596,34 @@ "basicAuth": [] } ], - "summary": "Get a Client Certificate Authority object.", + "summary": "Get a User object.", "tags": [ "all", - "clientCertAuthority" + "about" ], "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|\ncrlUrl|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "updateClientCertAuthority", + } + }, + "/about/user/msgVpns": { + "get": { + "description": "Get a list of User Message VPN objects.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", + "operationId": "getAboutUserMsgVpns", "parameters": [ { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" }, { - "description": "The Client Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClientCertAuthority" - } + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" }, { "$ref": "#/parameters/opaquePasswordQuery" }, + { + "$ref": "#/parameters/whereQuery" + }, { "$ref": "#/parameters/selectQuery" }, @@ -37497,9 +34636,9 @@ ], "responses": { "200": { - "description": "The Client Certificate Authority object's attributes after being updated, and the request metadata.", + "description": "The list of User Message VPN objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" + "$ref": "#/definitions/AboutUserMsgVpnsResponse" } }, "default": { @@ -37514,33 +34653,26 @@ "basicAuth": [] } ], - "summary": "Update a Client Certificate Authority object.", + "summary": "Get a list of User Message VPN objects.", "tags": [ "all", - "clientCertAuthority" + "about" ], "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|\ncrlUrl|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "replaceClientCertAuthority", + } + }, + "/about/user/msgVpns/{msgVpnName}": { + "get": { + "description": "Get a User Message VPN object.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "getAboutUserMsgVpn", "parameters": [ { - "description": "The name of the Certificate Authority.", + "description": "The name of the Message VPN.", "in": "path", - "name": "certAuthorityName", + "name": "msgVpnName", "required": true, "type": "string" }, - { - "description": "The Client Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClientCertAuthority" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -37556,9 +34688,9 @@ ], "responses": { "200": { - "description": "The Client Certificate Authority object's attributes after being replaced, and the request metadata.", + "description": "The User Message VPN object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" + "$ref": "#/definitions/AboutUserMsgVpnResponse" } }, "default": { @@ -37573,25 +34705,28 @@ "basicAuth": [] } ], - "summary": "Replace a Client Certificate Authority object.", + "summary": "Get a User Message VPN object.", "tags": [ "all", - "clientCertAuthority" + "about" ], "x-supportedInSempDirect": false } }, - "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { + "/certAuthorities": { "get": { - "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\nocspTlsTrustedCommonName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", - "operationId": "getClientCertAuthorityOcspTlsTrustedCommonNames", + "deprecated": true, + "description": "Get a list of Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\ncertContent||x\ncrlDayList||x\ncrlTimeList||x\ncrlUrl||x\nocspNonResponderCertEnabled||x\nocspOverrideUrl||x\nocspTimeout||x\nrevocationCheckEnabled||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "getCertAuthorities", "parameters": [ { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -37611,9 +34746,9 @@ ], "responses": { "200": { - "description": "The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.", + "description": "The list of Certificate Authority objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse" + "$ref": "#/definitions/CertAuthoritiesResponse" } }, "default": { @@ -37628,31 +34763,25 @@ "basicAuth": [] } ], - "summary": "Get a list of OCSP Responder Trusted Common Name objects.", + "summary": "Get a list of Certificate Authority objects.", "tags": [ "all", - "clientCertAuthority" + "certAuthority" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x\nocspTlsTrustedCommonName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "createClientCertAuthorityOcspTlsTrustedCommonName", + "deprecated": true, + "description": "Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|x|x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl||||x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "createCertAuthority", "parameters": [ { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "description": "The OCSP Responder Trusted Common Name object's attributes.", + "description": "The Certificate Authority object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonName" + "$ref": "#/definitions/CertAuthority" } }, { @@ -37670,9 +34799,9 @@ ], "responses": { "200": { - "description": "The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.", + "description": "The Certificate Authority object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" + "$ref": "#/definitions/CertAuthorityResponse" } }, "default": { @@ -37687,18 +34816,19 @@ "basicAuth": [] } ], - "summary": "Create an OCSP Responder Trusted Common Name object.", + "summary": "Create a Certificate Authority object.", "tags": [ "all", - "clientCertAuthority" + "certAuthority" ], "x-supportedInSempDirect": false } }, - "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}": { + "/certAuthorities/{certAuthorityName}": { "delete": { - "description": "Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "deleteClientCertAuthorityOcspTlsTrustedCommonName", + "deprecated": true, + "description": "Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "deleteCertAuthority", "parameters": [ { "description": "The name of the Certificate Authority.", @@ -37707,13 +34837,6 @@ "required": true, "type": "string" }, - { - "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", - "in": "path", - "name": "ocspTlsTrustedCommonName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -37740,16 +34863,17 @@ "basicAuth": [] } ], - "summary": "Delete an OCSP Responder Trusted Common Name object.", + "summary": "Delete a Certificate Authority object.", "tags": [ "all", - "clientCertAuthority" + "certAuthority" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\nocspTlsTrustedCommonName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "getClientCertAuthorityOcspTlsTrustedCommonName", + "deprecated": true, + "description": "Get a Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\ncertContent||x\ncrlDayList||x\ncrlTimeList||x\ncrlUrl||x\nocspNonResponderCertEnabled||x\nocspOverrideUrl||x\nocspTimeout||x\nrevocationCheckEnabled||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "getCertAuthority", "parameters": [ { "description": "The name of the Certificate Authority.", @@ -37758,13 +34882,6 @@ "required": true, "type": "string" }, - { - "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", - "in": "path", - "name": "ocspTlsTrustedCommonName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -37780,9 +34897,9 @@ ], "responses": { "200": { - "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", + "description": "The Certificate Authority object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" + "$ref": "#/definitions/CertAuthorityResponse" } }, "default": { @@ -37797,34 +34914,37 @@ "basicAuth": [] } ], - "summary": "Get an OCSP Responder Trusted Common Name object.", + "summary": "Get a Certificate Authority object.", "tags": [ "all", - "clientCertAuthority" + "certAuthority" ], "x-supportedInSempDirect": false - } - }, - "/dmrClusters": { - "get": { - "description": "Get a list of Cluster objects.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\ndmrClusterName|x|||\ntlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getDmrClusters", + }, + "patch": { + "deprecated": true, + "description": "Update a Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl|||x|x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "updateCertAuthority", "parameters": [ { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertAuthority" + } }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -37837,9 +34957,9 @@ ], "responses": { "200": { - "description": "The list of Cluster objects' attributes, and the request metadata.", + "description": "The Certificate Authority object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClustersResponse" + "$ref": "#/definitions/CertAuthorityResponse" } }, "default": { @@ -37854,24 +34974,32 @@ "basicAuth": [] } ], - "summary": "Get a list of Cluster objects.", + "summary": "Update a Certificate Authority object.", "tags": [ "all", - "dmrCluster" + "certAuthority" ], "x-supportedInSempDirect": false }, - "post": { - "description": "Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\nauthenticationClientCertContent|||||x||x\nauthenticationClientCertPassword|||||x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|x||||\nnodeName||||x|||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createDmrCluster", + "put": { + "deprecated": true, + "description": "Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl|||x|x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "replaceCertAuthority", "parameters": [ { - "description": "The Cluster object's attributes.", + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Authority object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrCluster" + "$ref": "#/definitions/CertAuthority" } }, { @@ -37889,9 +35017,9 @@ ], "responses": { "200": { - "description": "The Cluster object's attributes after being created, and the request metadata.", + "description": "The Certificate Authority object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterResponse" + "$ref": "#/definitions/CertAuthorityResponse" } }, "default": { @@ -37906,26 +35034,36 @@ "basicAuth": [] } ], - "summary": "Create a Cluster object.", + "summary": "Replace a Certificate Authority object.", "tags": [ "all", - "dmrCluster" + "certAuthority" ], "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}": { - "delete": { - "description": "Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteDmrCluster", + "/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { + "get": { + "deprecated": true, + "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\nocspTlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "getCertAuthorityOcspTlsTrustedCommonNames", "parameters": [ { - "description": "The name of the Cluster.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "dmrClusterName", + "name": "certAuthorityName", "required": true, "type": "string" }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, { "$ref": "#/parameters/solSessionHeader" } @@ -37935,9 +35073,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNamesResponse" } }, "default": { @@ -37952,24 +35090,34 @@ "basicAuth": [] } ], - "summary": "Delete a Cluster object.", + "summary": "Get a list of OCSP Responder Trusted Common Name objects.", "tags": [ "all", - "dmrCluster" + "certAuthority" ], "x-supportedInSempDirect": false }, - "get": { - "description": "Get a Cluster object.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\ndmrClusterName|x|||\ntlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getDmrCluster", + "post": { + "deprecated": true, + "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x|x\nocspTlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "createCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Cluster.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "dmrClusterName", + "name": "certAuthorityName", "required": true, "type": "string" }, + { + "description": "The OCSP Responder Trusted Common Name object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonName" + } + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -37985,9 +35133,9 @@ ], "responses": { "200": { - "description": "The Cluster object's attributes, and the request metadata.", + "description": "The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterResponse" + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameResponse" } }, "default": { @@ -38002,38 +35150,33 @@ "basicAuth": [] } ], - "summary": "Get a Cluster object.", + "summary": "Create an OCSP Responder Trusted Common Name object.", "tags": [ "all", - "dmrCluster" + "certAuthority" ], "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|||||\nnodeName|||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "updateDmrCluster", + } + }, + "/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}": { + "delete": { + "deprecated": true, + "description": "Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "deleteCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Cluster.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "dmrClusterName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The Cluster object's attributes.", - "in": "body", - "name": "body", + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", + "in": "path", + "name": "ocspTlsTrustedCommonName", "required": true, - "schema": { - "$ref": "#/definitions/DmrCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" + "type": "string" }, { "$ref": "#/parameters/solSessionHeader" @@ -38044,9 +35187,9 @@ ], "responses": { "200": { - "description": "The Cluster object's attributes after being updated, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -38061,32 +35204,31 @@ "basicAuth": [] } ], - "summary": "Update a Cluster object.", + "summary": "Delete an OCSP Responder Trusted Common Name object.", "tags": [ "all", - "dmrCluster" + "certAuthority" ], "x-supportedInSempDirect": false }, - "put": { - "description": "Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|||||\nnodeName|||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "replaceDmrCluster", + "get": { + "deprecated": true, + "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\nocspTlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "getCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Cluster.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "dmrClusterName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The Cluster object's attributes.", - "in": "body", - "name": "body", + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", + "in": "path", + "name": "ocspTlsTrustedCommonName", "required": true, - "schema": { - "$ref": "#/definitions/DmrCluster" - } + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -38103,9 +35245,9 @@ ], "responses": { "200": { - "description": "The Cluster object's attributes after being replaced, and the request metadata.", + "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterResponse" + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameResponse" } }, "default": { @@ -38120,26 +35262,19 @@ "basicAuth": [] } ], - "summary": "Replace a Cluster object.", + "summary": "Get an OCSP Responder Trusted Common Name object.", "tags": [ "all", - "dmrCluster" + "certAuthority" ], "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}/certMatchingRules": { + "/clientCertAuthorities": { "get": { - "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterCertMatchingRules", + "description": "Get a list of Client Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthorities", "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -38167,9 +35302,9 @@ ], "responses": { "200": { - "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", + "description": "The list of Client Certificate Authority objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRulesResponse" + "$ref": "#/definitions/ClientCertAuthoritiesResponse" } }, "default": { @@ -38184,31 +35319,24 @@ "basicAuth": [] } ], - "summary": "Get a list of Certificate Matching Rule objects.", + "summary": "Get a list of Client Certificate Authority objects.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nruleName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "createDmrClusterCertMatchingRule", + "description": "Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "createClientCertAuthority", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Matching Rule object's attributes.", + "description": "The Client Certificate Authority object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" + "$ref": "#/definitions/ClientCertAuthority" } }, { @@ -38226,9 +35354,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", + "description": "The Client Certificate Authority object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + "$ref": "#/definitions/ClientCertAuthorityResponse" } }, "default": { @@ -38243,30 +35371,23 @@ "basicAuth": [] } ], - "summary": "Create a Certificate Matching Rule object.", + "summary": "Create a Client Certificate Authority object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}": { + "/clientCertAuthorities/{certAuthorityName}": { "delete": { - "description": "Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "deleteDmrClusterCertMatchingRule", + "description": "Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "deleteClientCertAuthority", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, @@ -38296,28 +35417,21 @@ "basicAuth": [] } ], - "summary": "Delete a Certificate Matching Rule object.", + "summary": "Delete a Client Certificate Authority object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterCertMatchingRule", + "description": "Get a Client Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthority", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, @@ -38336,9 +35450,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes, and the request metadata.", + "description": "The Client Certificate Authority object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + "$ref": "#/definitions/ClientCertAuthorityResponse" } }, "default": { @@ -38353,38 +35467,31 @@ "basicAuth": [] } ], - "summary": "Get a Certificate Matching Rule object.", + "summary": "Get a Client Certificate Authority object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "updateDmrClusterCertMatchingRule", + "description": "Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|\ncrlUrl|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "updateClientCertAuthority", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule object's attributes.", + "description": "The Client Certificate Authority object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" + "$ref": "#/definitions/ClientCertAuthority" } }, { @@ -38402,9 +35509,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", + "description": "The Client Certificate Authority object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + "$ref": "#/definitions/ClientCertAuthorityResponse" } }, "default": { @@ -38419,38 +35526,31 @@ "basicAuth": [] } ], - "summary": "Update a Certificate Matching Rule object.", + "summary": "Update a Client Certificate Authority object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "replaceDmrClusterCertMatchingRule", + "description": "Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|\ncrlUrl|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "replaceClientCertAuthority", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule object's attributes.", + "description": "The Client Certificate Authority object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" + "$ref": "#/definitions/ClientCertAuthority" } }, { @@ -38468,9 +35568,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", + "description": "The Client Certificate Authority object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + "$ref": "#/definitions/ClientCertAuthorityResponse" } }, "default": { @@ -38485,42 +35585,26 @@ "basicAuth": [] } ], - "summary": "Replace a Certificate Matching Rule object.", + "summary": "Replace a Client Certificate Authority object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters": { + "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { "get": { - "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nfilterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterCertMatchingRuleAttributeFilters", + "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\nocspTlsTrustedCommonName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthorityOcspTlsTrustedCommonNames", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -38539,9 +35623,9 @@ ], "responses": { "200": { - "description": "The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.", + "description": "The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFiltersResponse" + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse" } }, "default": { @@ -38556,38 +35640,31 @@ "basicAuth": [] } ], - "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", + "summary": "Get a list of OCSP Responder Trusted Common Name objects.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nfilterName|x|x|x|\nruleName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "createDmrClusterCertMatchingRuleAttributeFilter", + "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x\nocspTlsTrustedCommonName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "createClientCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "description": "The OCSP Responder Trusted Common Name object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonName" } }, { @@ -38605,9 +35682,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.", + "description": "The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" } }, "default": { @@ -38622,37 +35699,30 @@ "basicAuth": [] } ], - "summary": "Create a Certificate Matching Rule Attribute Filter object.", + "summary": "Create an OCSP Responder Trusted Common Name object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { + "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}": { "delete": { - "description": "Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "deleteDmrClusterCertMatchingRuleAttributeFilter", + "description": "Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "deleteClientCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The name of the filter.", + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", "in": "path", - "name": "filterName", + "name": "ocspTlsTrustedCommonName", "required": true, "type": "string" }, @@ -38682,35 +35752,28 @@ "basicAuth": [] } ], - "summary": "Delete a Certificate Matching Rule Attribute Filter object.", + "summary": "Delete an OCSP Responder Trusted Common Name object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nfilterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterCertMatchingRuleAttributeFilter", + "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\nocspTlsTrustedCommonName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "ruleName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The name of the filter.", + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", "in": "path", - "name": "filterName", + "name": "ocspTlsTrustedCommonName", "required": true, "type": "string" }, @@ -38729,9 +35792,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", + "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" } }, "default": { @@ -38746,49 +35809,33 @@ "basicAuth": [] } ], - "summary": "Get a Certificate Matching Rule Attribute Filter object.", + "summary": "Get an OCSP Responder Trusted Common Name object.", "tags": [ "all", - "dmrCluster" + "clientCertAuthority" ], - "x-supportedInSempDirect": true - }, - "patch": { - "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nfilterName|x|x|\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "updateDmrClusterCertMatchingRuleAttributeFilter", + "x-supportedInSempDirect": false + } + }, + "/dmrClusters": { + "get": { + "description": "Get a list of Cluster objects.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\ndmrClusterName|x|||\ntlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusters", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" }, { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" + "$ref": "#/parameters/cursorQuery" }, { - "description": "The name of the filter.", - "in": "path", - "name": "filterName", - "required": true, - "type": "string" + "$ref": "#/parameters/forceFullPageQuery" }, { - "description": "The Certificate Matching Rule Attribute Filter object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" - } + "$ref": "#/parameters/opaquePasswordQuery" }, { - "$ref": "#/parameters/opaquePasswordQuery" + "$ref": "#/parameters/whereQuery" }, { "$ref": "#/parameters/selectQuery" @@ -38802,9 +35849,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.", + "description": "The list of Cluster objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/DmrClustersResponse" } }, "default": { @@ -38819,45 +35866,24 @@ "basicAuth": [] } ], - "summary": "Update a Certificate Matching Rule Attribute Filter object.", + "summary": "Get a list of Cluster objects.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, - "put": { - "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nfilterName|x|x|\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "replaceDmrClusterCertMatchingRuleAttributeFilter", + "post": { + "description": "Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\nauthenticationClientCertContent|||||x||x\nauthenticationClientCertPassword|||||x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|x||||\nnodeName||||x|||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createDmrCluster", "parameters": [ { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "description": "The name of the filter.", - "in": "path", - "name": "filterName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "description": "The Cluster object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + "$ref": "#/definitions/DmrCluster" } }, { @@ -38875,9 +35901,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.", + "description": "The Cluster object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/DmrClusterResponse" } }, "default": { @@ -38892,18 +35918,18 @@ "basicAuth": [] } ], - "summary": "Replace a Certificate Matching Rule Attribute Filter object.", + "summary": "Create a Cluster object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions": { - "get": { - "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterCertMatchingRuleConditions", + "/dmrClusters/{dmrClusterName}": { + "delete": { + "description": "Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteDmrCluster", "parameters": [ { "description": "The name of the Cluster.", @@ -38912,31 +35938,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -38946,9 +35947,9 @@ ], "responses": { "200": { - "description": "The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionsResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -38963,16 +35964,16 @@ "basicAuth": [] } ], - "summary": "Get a list of Certificate Matching Rule Condition objects.", + "summary": "Delete a Cluster object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, - "post": { - "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattribute||x||\ndmrClusterName|x|||x\nexpression||x||\nruleName|x|||x\nsource|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "createDmrClusterCertMatchingRuleCondition", + "get": { + "description": "Get a Cluster object.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\ndmrClusterName|x|||\ntlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrCluster", "parameters": [ { "description": "The name of the Cluster.", @@ -38981,22 +35982,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Matching Rule Condition object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -39012,9 +35997,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", + "description": "The Cluster object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" + "$ref": "#/definitions/DmrClusterResponse" } }, "default": { @@ -39029,18 +36014,16 @@ "basicAuth": [] } ], - "summary": "Create a Certificate Matching Rule Condition object.", + "summary": "Get a Cluster object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": true - } - }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}": { - "delete": { - "description": "Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "deleteDmrClusterCertMatchingRuleCondition", + "x-supportedInSempDirect": false + }, + "patch": { + "description": "Update a Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|||||\nnodeName|||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateDmrCluster", "parameters": [ { "description": "The name of the Cluster.", @@ -39050,18 +36033,19 @@ "type": "string" }, { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", + "description": "The Cluster object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/DmrCluster" + } }, { - "description": "Certificate field to be compared with the Attribute.", - "in": "path", - "name": "source", - "required": true, - "type": "string" + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -39072,9 +36056,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The Cluster object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/DmrClusterResponse" } }, "default": { @@ -39089,16 +36073,16 @@ "basicAuth": [] } ], - "summary": "Delete a Certificate Matching Rule Condition object.", + "summary": "Update a Cluster object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, - "get": { - "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterCertMatchingRuleCondition", + "put": { + "description": "Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|||||\nnodeName|||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceDmrCluster", "parameters": [ { "description": "The name of the Cluster.", @@ -39108,18 +36092,13 @@ "type": "string" }, { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "description": "Certificate field to be compared with the Attribute.", - "in": "path", - "name": "source", + "description": "The Cluster object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/DmrCluster" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -39136,9 +36115,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", + "description": "The Cluster object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" + "$ref": "#/definitions/DmrClusterResponse" } }, "default": { @@ -39153,18 +36132,18 @@ "basicAuth": [] } ], - "summary": "Get a Certificate Matching Rule Condition object.", + "summary": "Replace a Cluster object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}/links": { + "/dmrClusters/{dmrClusterName}/certMatchingRules": { "get": { - "description": "Get a list of Link objects.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\ndmrClusterName|x||\nremoteNodeName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getDmrClusterLinks", + "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRules", "parameters": [ { "description": "The name of the Cluster.", @@ -39200,9 +36179,9 @@ ], "responses": { "200": { - "description": "The list of Link objects' attributes, and the request metadata.", + "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinksResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRulesResponse" } }, "default": { @@ -39217,16 +36196,16 @@ "basicAuth": [] } ], - "summary": "Get a list of Link objects.", + "summary": "Get a list of Certificate Matching Rule objects.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { - "description": "Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\ndmrClusterName|x|||x||\nremoteNodeName|x|x|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createDmrClusterLink", + "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nruleName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterCertMatchingRule", "parameters": [ { "description": "The name of the Cluster.", @@ -39236,12 +36215,12 @@ "type": "string" }, { - "description": "The Link object's attributes.", + "description": "The Certificate Matching Rule object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterLink" + "$ref": "#/definitions/DmrClusterCertMatchingRule" } }, { @@ -39259,9 +36238,9 @@ ], "responses": { "200": { - "description": "The Link object's attributes after being created, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" } }, "default": { @@ -39276,18 +36255,18 @@ "basicAuth": [] } ], - "summary": "Create a Link object.", + "summary": "Create a Certificate Matching Rule object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}": { + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}": { "delete": { - "description": "Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteDmrClusterLink", + "description": "Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterCertMatchingRule", "parameters": [ { "description": "The name of the Cluster.", @@ -39297,9 +36276,9 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, @@ -39329,16 +36308,16 @@ "basicAuth": [] } ], - "summary": "Delete a Link object.", + "summary": "Delete a Certificate Matching Rule object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { - "description": "Get a Link object.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\ndmrClusterName|x||\nremoteNodeName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getDmrClusterLink", + "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRule", "parameters": [ { "description": "The name of the Cluster.", @@ -39348,9 +36327,9 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, @@ -39369,9 +36348,9 @@ ], "responses": { "200": { - "description": "The Link object's attributes, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" } }, "default": { @@ -39386,16 +36365,16 @@ "basicAuth": [] } ], - "summary": "Get a Link object.", + "summary": "Get a Certificate Matching Rule object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Link object. Any attribute missing from the request will be left unchanged.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationScheme|||||x|\ndmrClusterName|x||x|||\negressFlowWindowSize|||||x|\ninitiator|||||x|\nremoteNodeName|x|x||||\nspan|||||x|\ntransportCompressedEnabled|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "updateDmrClusterLink", + "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "updateDmrClusterCertMatchingRule", "parameters": [ { "description": "The name of the Cluster.", @@ -39405,19 +36384,19 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Link object's attributes.", + "description": "The Certificate Matching Rule object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterLink" + "$ref": "#/definitions/DmrClusterCertMatchingRule" } }, { @@ -39435,9 +36414,9 @@ ], "responses": { "200": { - "description": "The Link object's attributes after being updated, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" } }, "default": { @@ -39452,16 +36431,16 @@ "basicAuth": [] } ], - "summary": "Update a Link object.", + "summary": "Update a Certificate Matching Rule object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationScheme|||||x|\ndmrClusterName|x||x|||\negressFlowWindowSize|||||x|\ninitiator|||||x|\nremoteNodeName|x|x||||\nspan|||||x|\ntransportCompressedEnabled|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "replaceDmrClusterLink", + "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "replaceDmrClusterCertMatchingRule", "parameters": [ { "description": "The name of the Cluster.", @@ -39471,19 +36450,19 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Link object's attributes.", + "description": "The Certificate Matching Rule object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterLink" + "$ref": "#/definitions/DmrClusterCertMatchingRule" } }, { @@ -39501,9 +36480,9 @@ ], "responses": { "200": { - "description": "The Link object's attributes after being replaced, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" } }, "default": { @@ -39518,18 +36497,18 @@ "basicAuth": [] } ], - "summary": "Replace a Link object.", + "summary": "Replace a Certificate Matching Rule object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes": { + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters": { "get": { - "description": "Get a list of Link Attribute objects.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\ndmrClusterName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterLinkAttributes", + "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nfilterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleAttributeFilters", "parameters": [ { "description": "The name of the Cluster.", @@ -39539,9 +36518,9 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, @@ -39572,9 +36551,9 @@ ], "responses": { "200": { - "description": "The list of Link Attribute objects' attributes, and the request metadata.", + "description": "The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkAttributesResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFiltersResponse" } }, "default": { @@ -39589,7 +36568,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Link Attribute objects.", + "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", "tags": [ "all", "dmrCluster" @@ -39597,8 +36576,8 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattributeName|x|x|x|\nattributeValue|x|x|x|\ndmrClusterName|x|||x\nremoteNodeName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "createDmrClusterLinkAttribute", + "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nfilterName|x|x|x|\nruleName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Cluster.", @@ -39608,19 +36587,19 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Link Attribute object's attributes.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterLinkAttribute" + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" } }, { @@ -39638,9 +36617,9 @@ ], "responses": { "200": { - "description": "The Link Attribute object's attributes after being created, and the request metadata.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkAttributeResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" } }, "default": { @@ -39655,7 +36634,7 @@ "basicAuth": [] } ], - "summary": "Create a Link Attribute object.", + "summary": "Create a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "dmrCluster" @@ -39663,10 +36642,10 @@ "x-supportedInSempDirect": true } }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}": { + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { "delete": { - "description": "Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "deleteDmrClusterLinkAttribute", + "description": "Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Cluster.", @@ -39676,26 +36655,83 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The name of the Attribute.", + "description": "The name of the filter.", "in": "path", - "name": "attributeName", + "name": "filterName", "required": true, "type": "string" }, { - "description": "The value of the Attribute.", + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "dmrCluster" + ], + "x-supportedInSempDirect": true + }, + "get": { + "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nfilterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Cluster.", "in": "path", - "name": "attributeValue", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", "required": true, "type": "string" }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, { "$ref": "#/parameters/solSessionHeader" } @@ -39705,9 +36741,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" } }, "default": { @@ -39722,16 +36758,16 @@ "basicAuth": [] } ], - "summary": "Delete a Link Attribute object.", + "summary": "Get a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "dmrCluster" ], "x-supportedInSempDirect": true }, - "get": { - "description": "Get a Link Attribute object.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\ndmrClusterName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "getDmrClusterLinkAttribute", + "patch": { + "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nfilterName|x|x|\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "updateDmrClusterCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Cluster.", @@ -39741,26 +36777,101 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The name of the Attribute.", + "description": "The name of the filter.", "in": "path", - "name": "attributeName", + "name": "filterName", "required": true, "type": "string" }, { - "description": "The value of the Attribute.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "dmrCluster" + ], + "x-supportedInSempDirect": true + }, + "put": { + "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nfilterName|x|x|\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "replaceDmrClusterCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Cluster.", "in": "path", - "name": "attributeValue", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", "required": true, "type": "string" }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + } + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -39776,9 +36887,9 @@ ], "responses": { "200": { - "description": "The Link Attribute object's attributes, and the request metadata.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkAttributeResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" } }, "default": { @@ -39793,7 +36904,7 @@ "basicAuth": [] } ], - "summary": "Get a Link Attribute object.", + "summary": "Replace a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "dmrCluster" @@ -39801,10 +36912,10 @@ "x-supportedInSempDirect": true } }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses": { + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions": { "get": { - "description": "Get a list of Remote Address objects.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nremoteAddress|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getDmrClusterLinkRemoteAddresses", + "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleConditions", "parameters": [ { "description": "The name of the Cluster.", @@ -39814,12 +36925,21 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -39838,9 +36958,9 @@ ], "responses": { "200": { - "description": "The list of Remote Address objects' attributes, and the request metadata.", + "description": "The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressesResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionsResponse" } }, "default": { @@ -39855,16 +36975,16 @@ "basicAuth": [] } ], - "summary": "Get a list of Remote Address objects.", + "summary": "Get a list of Certificate Matching Rule Condition objects.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { - "description": "Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nremoteAddress|x|x|x|\nremoteNodeName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createDmrClusterLinkRemoteAddress", + "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattribute||x||\ndmrClusterName|x|||x\nexpression||x||\nruleName|x|||x\nsource|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterCertMatchingRuleCondition", "parameters": [ { "description": "The name of the Cluster.", @@ -39874,19 +36994,19 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Remote Address object's attributes.", + "description": "The Certificate Matching Rule Condition object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddress" + "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" } }, { @@ -39904,9 +37024,9 @@ ], "responses": { "200": { - "description": "The Remote Address object's attributes after being created, and the request metadata.", + "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" } }, "default": { @@ -39921,18 +37041,18 @@ "basicAuth": [] } ], - "summary": "Create a Remote Address object.", + "summary": "Create a Certificate Matching Rule Condition object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}": { + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}": { "delete": { - "description": "Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteDmrClusterLinkRemoteAddress", + "description": "Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterCertMatchingRuleCondition", "parameters": [ { "description": "The name of the Cluster.", @@ -39942,16 +37062,16 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", + "description": "Certificate field to be compared with the Attribute.", "in": "path", - "name": "remoteAddress", + "name": "source", "required": true, "type": "string" }, @@ -39981,16 +37101,16 @@ "basicAuth": [] } ], - "summary": "Delete a Remote Address object.", + "summary": "Delete a Certificate Matching Rule Condition object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { - "description": "Get a Remote Address object.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nremoteAddress|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getDmrClusterLinkRemoteAddress", + "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleCondition", "parameters": [ { "description": "The name of the Cluster.", @@ -40000,16 +37120,16 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", + "description": "The name of the rule.", "in": "path", - "name": "remoteNodeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", + "description": "Certificate field to be compared with the Attribute.", "in": "path", - "name": "remoteAddress", + "name": "source", "required": true, "type": "string" }, @@ -40028,9 +37148,9 @@ ], "responses": { "200": { - "description": "The Remote Address object's attributes, and the request metadata.", + "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" } }, "default": { @@ -40045,19 +37165,18 @@ "basicAuth": [] } ], - "summary": "Get a Remote Address object.", + "summary": "Get a Certificate Matching Rule Condition object.", "tags": [ "all", "dmrCluster" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames": { + "/dmrClusters/{dmrClusterName}/links": { "get": { - "deprecated": true, - "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ndmrClusterName|x|x\nremoteNodeName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "getDmrClusterLinkTlsTrustedCommonNames", + "description": "Get a list of Link objects.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\ndmrClusterName|x||\nremoteNodeName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLinks", "parameters": [ { "description": "The name of the Cluster.", @@ -40067,11 +37186,13 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", - "in": "path", - "name": "remoteNodeName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -40091,9 +37212,9 @@ ], "responses": { "200": { - "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", + "description": "The list of Link objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNamesResponse" + "$ref": "#/definitions/DmrClusterLinksResponse" } }, "default": { @@ -40108,7 +37229,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Trusted Common Name objects.", + "summary": "Get a list of Link objects.", "tags": [ "all", "dmrCluster" @@ -40116,9 +37237,8 @@ "x-supportedInSempDirect": false }, "post": { - "deprecated": true, - "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x|x\nremoteNodeName|x|||x|x\ntlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "createDmrClusterLinkTlsTrustedCommonName", + "description": "Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\ndmrClusterName|x|||x||\nremoteNodeName|x|x|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createDmrClusterLink", "parameters": [ { "description": "The name of the Cluster.", @@ -40128,19 +37248,12 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the Link.", - "in": "path", - "name": "remoteNodeName", - "required": true, - "type": "string" - }, - { - "description": "The Trusted Common Name object's attributes.", + "description": "The Link object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" + "$ref": "#/definitions/DmrClusterLink" } }, { @@ -40158,9 +37271,9 @@ ], "responses": { "200": { - "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", + "description": "The Link object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" + "$ref": "#/definitions/DmrClusterLinkResponse" } }, "default": { @@ -40175,7 +37288,7 @@ "basicAuth": [] } ], - "summary": "Create a Trusted Common Name object.", + "summary": "Create a Link object.", "tags": [ "all", "dmrCluster" @@ -40183,11 +37296,10 @@ "x-supportedInSempDirect": false } }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}": { "delete": { - "deprecated": true, - "description": "Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "deleteDmrClusterLinkTlsTrustedCommonName", + "description": "Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteDmrClusterLink", "parameters": [ { "description": "The name of the Cluster.", @@ -40203,13 +37315,6 @@ "required": true, "type": "string" }, - { - "description": "The expected trusted common name of the remote certificate.", - "in": "path", - "name": "tlsTrustedCommonName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -40236,7 +37341,7 @@ "basicAuth": [] } ], - "summary": "Delete a Trusted Common Name object.", + "summary": "Delete a Link object.", "tags": [ "all", "dmrCluster" @@ -40244,9 +37349,8 @@ "x-supportedInSempDirect": false }, "get": { - "deprecated": true, - "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ndmrClusterName|x|x\nremoteNodeName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "getDmrClusterLinkTlsTrustedCommonName", + "description": "Get a Link object.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\ndmrClusterName|x||\nremoteNodeName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLink", "parameters": [ { "description": "The name of the Cluster.", @@ -40262,13 +37366,6 @@ "required": true, "type": "string" }, - { - "description": "The expected trusted common name of the remote certificate.", - "in": "path", - "name": "tlsTrustedCommonName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -40284,9 +37381,9 @@ ], "responses": { "200": { - "description": "The Trusted Common Name object's attributes, and the request metadata.", + "description": "The Link object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" + "$ref": "#/definitions/DmrClusterLinkResponse" } }, "default": { @@ -40301,34 +37398,43 @@ "basicAuth": [] } ], - "summary": "Get a Trusted Common Name object.", + "summary": "Get a Link object.", "tags": [ "all", "dmrCluster" ], "x-supportedInSempDirect": false - } - }, - "/domainCertAuthorities": { - "get": { - "description": "Get a list of Domain Certificate Authority objects.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.19.", - "operationId": "getDomainCertAuthorities", + }, + "patch": { + "description": "Update a Link object. Any attribute missing from the request will be left unchanged.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationScheme|||||x|\ndmrClusterName|x||x|||\negressFlowWindowSize|||||x|\ninitiator|||||x|\nremoteNodeName|x|x||||\nspan|||||x|\ntransportCompressedEnabled|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateDmrClusterLink", "parameters": [ { - "$ref": "#/parameters/countQuery" + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/cursorQuery" + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The Link object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLink" + } }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -40341,9 +37447,9 @@ ], "responses": { "200": { - "description": "The list of Domain Certificate Authority objects' attributes, and the request metadata.", + "description": "The Link object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/DomainCertAuthoritiesResponse" + "$ref": "#/definitions/DmrClusterLinkResponse" } }, "default": { @@ -40358,24 +37464,38 @@ "basicAuth": [] } ], - "summary": "Get a list of Domain Certificate Authority objects.", + "summary": "Update a Link object.", "tags": [ "all", - "domainCertAuthority" + "dmrCluster" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, - "post": { - "description": "Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "createDomainCertAuthority", + "put": { + "description": "Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationScheme|||||x|\ndmrClusterName|x||x|||\negressFlowWindowSize|||||x|\ninitiator|||||x|\nremoteNodeName|x|x||||\nspan|||||x|\ntransportCompressedEnabled|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceDmrClusterLink", "parameters": [ { - "description": "The Domain Certificate Authority object's attributes.", + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Link object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DomainCertAuthority" + "$ref": "#/definitions/DmrClusterLink" } }, { @@ -40393,9 +37513,9 @@ ], "responses": { "200": { - "description": "The Domain Certificate Authority object's attributes after being created, and the request metadata.", + "description": "The Link object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" + "$ref": "#/definitions/DmrClusterLinkResponse" } }, "default": { @@ -40410,73 +37530,48 @@ "basicAuth": [] } ], - "summary": "Create a Domain Certificate Authority object.", + "summary": "Replace a Link object.", "tags": [ "all", - "domainCertAuthority" + "dmrCluster" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/domainCertAuthorities/{certAuthorityName}": { - "delete": { - "description": "Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "deleteDomainCertAuthority", + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes": { + "get": { + "description": "Get a list of Link Attribute objects.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\ndmrClusterName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterLinkAttributes", "parameters": [ { - "description": "The name of the Certificate Authority.", + "description": "The name of the Cluster.", "in": "path", - "name": "certAuthorityName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete a Domain Certificate Authority object.", - "tags": [ - "all", - "domainCertAuthority" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get a Domain Certificate Authority object.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "getDomainCertAuthority", - "parameters": [ - { - "description": "The name of the Certificate Authority.", + "description": "The name of the node at the remote end of the Link.", "in": "path", - "name": "certAuthorityName", + "name": "remoteNodeName", "required": true, "type": "string" }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" + }, { "$ref": "#/parameters/opaquePasswordQuery" }, + { + "$ref": "#/parameters/whereQuery" + }, { "$ref": "#/parameters/selectQuery" }, @@ -40489,9 +37584,9 @@ ], "responses": { "200": { - "description": "The Domain Certificate Authority object's attributes, and the request metadata.", + "description": "The list of Link Attribute objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" + "$ref": "#/definitions/DmrClusterLinkAttributesResponse" } }, "default": { @@ -40506,31 +37601,38 @@ "basicAuth": [] } ], - "summary": "Get a Domain Certificate Authority object.", + "summary": "Get a list of Link Attribute objects.", "tags": [ "all", - "domainCertAuthority" + "dmrCluster" ], "x-supportedInSempDirect": true }, - "patch": { - "description": "Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "updateDomainCertAuthority", + "post": { + "description": "Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattributeName|x|x|x|\nattributeValue|x|x|x|\ndmrClusterName|x|||x\nremoteNodeName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterLinkAttribute", "parameters": [ { - "description": "The name of the Certificate Authority.", + "description": "The name of the Cluster.", "in": "path", - "name": "certAuthorityName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "description": "The Domain Certificate Authority object's attributes.", + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Link Attribute object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/DomainCertAuthority" + "$ref": "#/definitions/DmrClusterLinkAttribute" } }, { @@ -40548,9 +37650,9 @@ ], "responses": { "200": { - "description": "The Domain Certificate Authority object's attributes after being updated, and the request metadata.", + "description": "The Link Attribute object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" + "$ref": "#/definitions/DmrClusterLinkAttributeResponse" } }, "default": { @@ -40565,38 +37667,46 @@ "basicAuth": [] } ], - "summary": "Update a Domain Certificate Authority object.", + "summary": "Create a Link Attribute object.", "tags": [ "all", - "domainCertAuthority" + "dmrCluster" ], "x-supportedInSempDirect": true - }, - "put": { - "description": "Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", - "operationId": "replaceDomainCertAuthority", + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}": { + "delete": { + "description": "Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterLinkAttribute", "parameters": [ { - "description": "The name of the Certificate Authority.", + "description": "The name of the Cluster.", "in": "path", - "name": "certAuthorityName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "description": "The Domain Certificate Authority object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", "required": true, - "schema": { - "$ref": "#/definitions/DomainCertAuthority" - } + "type": "string" }, { - "$ref": "#/parameters/opaquePasswordQuery" + "description": "The name of the Attribute.", + "in": "path", + "name": "attributeName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/selectQuery" + "description": "The value of the Attribute.", + "in": "path", + "name": "attributeValue", + "required": true, + "type": "string" }, { "$ref": "#/parameters/solSessionHeader" @@ -40607,9 +37717,9 @@ ], "responses": { "200": { - "description": "The Domain Certificate Authority object's attributes after being replaced, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -40624,33 +37734,47 @@ "basicAuth": [] } ], - "summary": "Replace a Domain Certificate Authority object.", + "summary": "Delete a Link Attribute object.", "tags": [ "all", - "domainCertAuthority" + "dmrCluster" ], "x-supportedInSempDirect": true - } - }, - "/msgVpns": { + }, "get": { - "description": "Get a list of Message VPN objects.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x|\ndistributedCacheManagementEnabled|||x|\nmsgVpnName|x|||\nreplicationBridgeAuthenticationBasicPassword||x||x\nreplicationBridgeAuthenticationClientCertContent||x||x\nreplicationBridgeAuthenticationClientCertPassword||x||\nreplicationEnabledQueueBehavior||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpns", + "description": "Get a Link Attribute object.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\ndmrClusterName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterLinkAttribute", "parameters": [ { - "$ref": "#/parameters/countQuery" + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/cursorQuery" + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The name of the Attribute.", + "in": "path", + "name": "attributeName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/opaquePasswordQuery" + "description": "The value of the Attribute.", + "in": "path", + "name": "attributeValue", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/whereQuery" + "$ref": "#/parameters/opaquePasswordQuery" }, { "$ref": "#/parameters/selectQuery" @@ -40664,9 +37788,9 @@ ], "responses": { "200": { - "description": "The list of Message VPN objects' attributes, and the request metadata.", + "description": "The Link Attribute object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnsResponse" + "$ref": "#/definitions/DmrClusterLinkAttributeResponse" } }, "default": { @@ -40681,29 +37805,39 @@ "basicAuth": [] } ], - "summary": "Get a list of Message VPN objects.", + "summary": "Get a Link Attribute object.", "tags": [ "all", - "msgVpn" + "dmrCluster" ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Required|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x|x|||\nreplicationBridgeAuthenticationBasicPassword||||x||x\nreplicationBridgeAuthenticationClientCertContent||||x||x\nreplicationBridgeAuthenticationClientCertPassword||||x||\nreplicationEnabledQueueBehavior||||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpn", + "x-supportedInSempDirect": true + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses": { + "get": { + "description": "Get a list of Remote Address objects.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nremoteAddress|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLinkRemoteAddresses", "parameters": [ { - "description": "The Message VPN object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpn" - } + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" }, + { + "$ref": "#/parameters/whereQuery" + }, { "$ref": "#/parameters/selectQuery" }, @@ -40716,9 +37850,9 @@ ], "responses": { "200": { - "description": "The Message VPN object's attributes after being created, and the request metadata.", + "description": "The list of Remote Address objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnResponse" + "$ref": "#/definitions/DmrClusterLinkRemoteAddressesResponse" } }, "default": { @@ -40733,70 +37867,40 @@ "basicAuth": [] } ], - "summary": "Create a Message VPN object.", + "summary": "Get a list of Remote Address objects.", "tags": [ "all", - "msgVpn" + "dmrCluster" ], "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}": { - "delete": { - "description": "Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpn", + }, + "post": { + "description": "Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nremoteAddress|x|x|x|\nremoteNodeName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createDmrClusterLinkRemoteAddress", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Cluster.", "in": "path", - "name": "msgVpnName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete a Message VPN object.", - "tags": [ - "all", - "msgVpn" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Message VPN object.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x|\ndistributedCacheManagementEnabled|||x|\nmsgVpnName|x|||\nreplicationBridgeAuthenticationBasicPassword||x||x\nreplicationBridgeAuthenticationClientCertContent||x||x\nreplicationBridgeAuthenticationClientCertPassword||x||\nreplicationEnabledQueueBehavior||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpn", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The name of the node at the remote end of the Link.", "in": "path", - "name": "msgVpnName", + "name": "remoteNodeName", "required": true, "type": "string" }, + { + "description": "The Remote Address object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddress" + } + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -40812,9 +37916,9 @@ ], "responses": { "200": { - "description": "The Message VPN object's attributes, and the request metadata.", + "description": "The Remote Address object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnResponse" + "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" } }, "default": { @@ -40829,38 +37933,39 @@ "basicAuth": [] } ], - "summary": "Get a Message VPN object.", + "summary": "Create a Remote Address object.", "tags": [ "all", - "msgVpn" + "dmrCluster" ], "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Message VPN object. Any attribute missing from the request will be left unchanged.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\nreplicationBridgeAuthenticationBasicPassword|||x|||x\nreplicationBridgeAuthenticationClientCertContent|||x|||x\nreplicationBridgeAuthenticationClientCertPassword|||x|||\nreplicationEnabledQueueBehavior|||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\nserviceAmqpPlainTextListenPort||||x||\nserviceAmqpTlsListenPort||||x||\nserviceMqttPlainTextListenPort||||x||\nserviceMqttTlsListenPort||||x||\nserviceMqttTlsWebSocketListenPort||||x||\nserviceMqttWebSocketListenPort||||x||\nserviceRestIncomingPlainTextListenPort||||x||\nserviceRestIncomingTlsListenPort||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", - "operationId": "updateMsgVpn", + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}": { + "delete": { + "description": "Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteDmrClusterLinkRemoteAddress", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Cluster.", "in": "path", - "name": "msgVpnName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "description": "The Message VPN object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpn" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" + "type": "string" }, { - "$ref": "#/parameters/selectQuery" + "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", + "in": "path", + "name": "remoteAddress", + "required": true, + "type": "string" }, { "$ref": "#/parameters/solSessionHeader" @@ -40871,9 +37976,9 @@ ], "responses": { "200": { - "description": "The Message VPN object's attributes after being updated, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -40888,32 +37993,37 @@ "basicAuth": [] } ], - "summary": "Update a Message VPN object.", + "summary": "Delete a Remote Address object.", "tags": [ "all", - "msgVpn" + "dmrCluster" ], "x-supportedInSempDirect": false }, - "put": { - "description": "Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\nreplicationBridgeAuthenticationBasicPassword|||x|||x\nreplicationBridgeAuthenticationClientCertContent|||x|||x\nreplicationBridgeAuthenticationClientCertPassword|||x|||\nreplicationEnabledQueueBehavior|||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\nserviceAmqpPlainTextListenPort||||x||\nserviceAmqpTlsListenPort||||x||\nserviceMqttPlainTextListenPort||||x||\nserviceMqttTlsListenPort||||x||\nserviceMqttTlsWebSocketListenPort||||x||\nserviceMqttWebSocketListenPort||||x||\nserviceRestIncomingPlainTextListenPort||||x||\nserviceRestIncomingTlsListenPort||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", - "operationId": "replaceMsgVpn", + "get": { + "description": "Get a Remote Address object.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nremoteAddress|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLinkRemoteAddress", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Cluster.", "in": "path", - "name": "msgVpnName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "description": "The Message VPN object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpn" - } + "type": "string" + }, + { + "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", + "in": "path", + "name": "remoteAddress", + "required": true, + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -40930,9 +38040,9 @@ ], "responses": { "200": { - "description": "The Message VPN object's attributes after being replaced, and the request metadata.", + "description": "The Remote Address object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnResponse" + "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" } }, "default": { @@ -40947,34 +38057,33 @@ "basicAuth": [] } ], - "summary": "Replace a Message VPN object.", + "summary": "Get a Remote Address object.", "tags": [ "all", - "msgVpn" + "dmrCluster" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles": { + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames": { "get": { - "description": "Get a list of ACL Profile objects.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnAclProfiles", + "deprecated": true, + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ndmrClusterName|x|x\nremoteNodeName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getDmrClusterLinkTlsTrustedCommonNames", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Cluster.", "in": "path", - "name": "msgVpnName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -40994,9 +38103,9 @@ ], "responses": { "200": { - "description": "The list of ACL Profile objects' attributes, and the request metadata.", + "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfilesResponse" + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNamesResponse" } }, "default": { @@ -41011,32 +38120,39 @@ "basicAuth": [] } ], - "summary": "Get a list of ACL Profile objects.", + "summary": "Get a list of Trusted Common Name objects.", "tags": [ "all", - "msgVpn", - "aclProfile" + "dmrCluster" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnAclProfile", + "deprecated": true, + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x|x\nremoteNodeName|x|||x|x\ntlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "createDmrClusterLinkTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Cluster.", "in": "path", - "name": "msgVpnName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "description": "The ACL Profile object's attributes.", + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Trusted Common Name object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAclProfile" + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" } }, { @@ -41054,9 +38170,9 @@ ], "responses": { "200": { - "description": "The ACL Profile object's attributes after being created, and the request metadata.", + "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" } }, "default": { @@ -41071,31 +38187,38 @@ "basicAuth": [] } ], - "summary": "Create an ACL Profile object.", + "summary": "Create a Trusted Common Name object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "dmrCluster" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}": { + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { "delete": { - "description": "Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnAclProfile", + "deprecated": true, + "description": "Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "deleteDmrClusterLinkTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Cluster.", "in": "path", - "name": "msgVpnName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "description": "The name of the ACL Profile.", + "description": "The name of the node at the remote end of the Link.", "in": "path", - "name": "aclProfileName", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", "required": true, "type": "string" }, @@ -41125,29 +38248,36 @@ "basicAuth": [] } ], - "summary": "Delete an ACL Profile object.", + "summary": "Delete a Trusted Common Name object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "dmrCluster" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get an ACL Profile object.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnAclProfile", + "deprecated": true, + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ndmrClusterName|x|x\nremoteNodeName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getDmrClusterLinkTlsTrustedCommonName", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Cluster.", "in": "path", - "name": "msgVpnName", + "name": "dmrClusterName", "required": true, "type": "string" }, { - "description": "The name of the ACL Profile.", + "description": "The name of the node at the remote end of the Link.", "in": "path", - "name": "aclProfileName", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", "required": true, "type": "string" }, @@ -41166,9 +38296,9 @@ ], "responses": { "200": { - "description": "The ACL Profile object's attributes, and the request metadata.", + "description": "The Trusted Common Name object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" } }, "default": { @@ -41183,44 +38313,34 @@ "basicAuth": [] } ], - "summary": "Get an ACL Profile object.", + "summary": "Get a Trusted Common Name object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "dmrCluster" ], "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update an ACL Profile object. Any attribute missing from the request will be left unchanged.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\naclProfileName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "updateMsgVpnAclProfile", + } + }, + "/domainCertAuthorities": { + "get": { + "description": "Get a list of Domain Certificate Authority objects.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.19.", + "operationId": "getDomainCertAuthorities", "parameters": [ { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" }, { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" + "$ref": "#/parameters/cursorQuery" }, { - "description": "The ACL Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfile" - } + "$ref": "#/parameters/forceFullPageQuery" }, { "$ref": "#/parameters/opaquePasswordQuery" }, + { + "$ref": "#/parameters/whereQuery" + }, { "$ref": "#/parameters/selectQuery" }, @@ -41233,9 +38353,9 @@ ], "responses": { "200": { - "description": "The ACL Profile object's attributes after being updated, and the request metadata.", + "description": "The list of Domain Certificate Authority objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" + "$ref": "#/definitions/DomainCertAuthoritiesResponse" } }, "default": { @@ -41250,39 +38370,24 @@ "basicAuth": [] } ], - "summary": "Update an ACL Profile object.", + "summary": "Get a list of Domain Certificate Authority objects.", "tags": [ "all", - "msgVpn", - "aclProfile" + "domainCertAuthority" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "put": { - "description": "Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\naclProfileName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "replaceMsgVpnAclProfile", + "post": { + "description": "Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "createDomainCertAuthority", "parameters": [ { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" - }, - { - "description": "The ACL Profile object's attributes.", + "description": "The Domain Certificate Authority object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAclProfile" + "$ref": "#/definitions/DomainCertAuthority" } }, { @@ -41300,9 +38405,9 @@ ], "responses": { "200": { - "description": "The ACL Profile object's attributes after being replaced, and the request metadata.", + "description": "The Domain Certificate Authority object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" + "$ref": "#/definitions/DomainCertAuthorityResponse" } }, "default": { @@ -41317,52 +38422,26 @@ "basicAuth": [] } ], - "summary": "Replace an ACL Profile object.", + "summary": "Create a Domain Certificate Authority object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "domainCertAuthority" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions": { - "get": { - "description": "Get a list of Client Connect Exception objects.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nclientConnectExceptionAddress|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnAclProfileClientConnectExceptions", + "/domainCertAuthorities/{certAuthorityName}": { + "delete": { + "description": "Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "deleteDomainCertAuthority", "parameters": [ { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ACL Profile.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "aclProfileName", + "name": "certAuthorityName", "required": true, "type": "string" }, - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -41372,9 +38451,9 @@ ], "responses": { "200": { - "description": "The list of Client Connect Exception objects' attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionsResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -41389,41 +38468,24 @@ "basicAuth": [] } ], - "summary": "Get a list of Client Connect Exception objects.", + "summary": "Delete a Domain Certificate Authority object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "domainCertAuthority" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "post": { - "description": "Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nclientConnectExceptionAddress|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnAclProfileClientConnectException", + "get": { + "description": "Get a Domain Certificate Authority object.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getDomainCertAuthority", "parameters": [ { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ACL Profile.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "aclProfileName", + "name": "certAuthorityName", "required": true, "type": "string" }, - { - "description": "The Client Connect Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -41439,9 +38501,9 @@ ], "responses": { "200": { - "description": "The Client Connect Exception object's attributes after being created, and the request metadata.", + "description": "The Domain Certificate Authority object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" + "$ref": "#/definitions/DomainCertAuthorityResponse" } }, "default": { @@ -41456,40 +38518,38 @@ "basicAuth": [] } ], - "summary": "Create a Client Connect Exception object.", + "summary": "Get a Domain Certificate Authority object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "domainCertAuthority" ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}": { - "delete": { - "description": "Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnAclProfileClientConnectException", + "x-supportedInSempDirect": true + }, + "patch": { + "description": "Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "updateDomainCertAuthority", "parameters": [ { - "description": "The name of the Message VPN.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "msgVpnName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", + "description": "The Domain Certificate Authority object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/DomainCertAuthority" + } }, { - "description": "The IP address/netmask of the client connect exception in canonical CIDR form.", - "in": "path", - "name": "clientConnectExceptionAddress", - "required": true, - "type": "string" + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -41500,9 +38560,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The Domain Certificate Authority object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/DomainCertAuthorityResponse" } }, "default": { @@ -41517,38 +38577,32 @@ "basicAuth": [] } ], - "summary": "Delete a Client Connect Exception object.", + "summary": "Update a Domain Certificate Authority object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "domainCertAuthority" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "get": { - "description": "Get a Client Connect Exception object.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nclientConnectExceptionAddress|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnAclProfileClientConnectException", + "put": { + "description": "Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "replaceDomainCertAuthority", "parameters": [ { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ACL Profile.", + "description": "The name of the Certificate Authority.", "in": "path", - "name": "aclProfileName", + "name": "certAuthorityName", "required": true, "type": "string" }, { - "description": "The IP address/netmask of the client connect exception in canonical CIDR form.", - "in": "path", - "name": "clientConnectExceptionAddress", + "description": "The Domain Certificate Authority object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/DomainCertAuthority" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -41565,9 +38619,9 @@ ], "responses": { "200": { - "description": "The Client Connect Exception object's attributes, and the request metadata.", + "description": "The Domain Certificate Authority object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" + "$ref": "#/definitions/DomainCertAuthorityResponse" } }, "default": { @@ -41582,35 +38636,19 @@ "basicAuth": [] } ], - "summary": "Get a Client Connect Exception object.", + "summary": "Replace a Domain Certificate Authority object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "domainCertAuthority" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions": { + "/msgVpns": { "get": { - "deprecated": true, - "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\npublishExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", - "operationId": "getMsgVpnAclProfilePublishExceptions", + "description": "Get a list of Message VPN objects.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x|\ndistributedCacheManagementEnabled|||x|\nmsgVpnName|x|||\npreferIpVersion|||x|\nreplicationBridgeAuthenticationBasicPassword||x||x\nreplicationBridgeAuthenticationClientCertContent||x||x\nreplicationBridgeAuthenticationClientCertPassword||x||\nreplicationEnabledQueueBehavior||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpns", "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -41638,9 +38676,9 @@ ], "responses": { "200": { - "description": "The list of Publish Topic Exception objects' attributes, and the request metadata.", + "description": "The list of Message VPN objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionsResponse" + "$ref": "#/definitions/MsgVpnsResponse" } }, "default": { @@ -41655,40 +38693,24 @@ "basicAuth": [] } ], - "summary": "Get a list of Publish Topic Exception objects.", + "summary": "Get a list of Message VPN objects.", "tags": [ "all", - "msgVpn", - "aclProfile" + "msgVpn" ], "x-supportedInSempDirect": false }, "post": { - "deprecated": true, - "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|x\nmsgVpnName|x|||x|x\npublishExceptionTopic|x|x|x||x\ntopicSyntax|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", - "operationId": "createMsgVpnAclProfilePublishException", + "description": "Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Required|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x|x|||\npreferIpVersion|||||x|\nreplicationBridgeAuthenticationBasicPassword||||x||x\nreplicationBridgeAuthenticationClientCertContent||||x||x\nreplicationBridgeAuthenticationClientCertPassword||||x||\nreplicationEnabledQueueBehavior||||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpn", "parameters": [ { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Publish Topic Exception object's attributes.", + "description": "The Message VPN object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishException" + "$ref": "#/definitions/MsgVpn" } }, { @@ -41706,9 +38728,9 @@ ], "responses": { "200": { - "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", + "description": "The Message VPN object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" + "$ref": "#/definitions/MsgVpnResponse" } }, "default": { @@ -41723,20 +38745,18 @@ "basicAuth": [] } ], - "summary": "Create a Publish Topic Exception object.", + "summary": "Create a Message VPN object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "msgVpn" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}": { + "/msgVpns/{msgVpnName}": { "delete": { - "deprecated": true, - "description": "Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", - "operationId": "deleteMsgVpnAclProfilePublishException", + "description": "Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -41745,27 +38765,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" - }, - { - "description": "The syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "topicSyntax", - "required": true, - "type": "string" - }, - { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "publishExceptionTopic", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -41792,18 +38791,16 @@ "basicAuth": [] } ], - "summary": "Delete a Publish Topic Exception object.", + "summary": "Delete a Message VPN object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "msgVpn" ], "x-supportedInSempDirect": false }, "get": { - "deprecated": true, - "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\npublishExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", - "operationId": "getMsgVpnAclProfilePublishException", + "description": "Get a Message VPN object.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x|\ndistributedCacheManagementEnabled|||x|\nmsgVpnName|x|||\npreferIpVersion|||x|\nreplicationBridgeAuthenticationBasicPassword||x||x\nreplicationBridgeAuthenticationClientCertContent||x||x\nreplicationBridgeAuthenticationClientCertPassword||x||\nreplicationEnabledQueueBehavior||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -41812,27 +38809,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" - }, - { - "description": "The syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "topicSyntax", - "required": true, - "type": "string" - }, - { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "publishExceptionTopic", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -41848,9 +38824,9 @@ ], "responses": { "200": { - "description": "The Publish Topic Exception object's attributes, and the request metadata.", + "description": "The Message VPN object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" + "$ref": "#/definitions/MsgVpnResponse" } }, "default": { @@ -41865,19 +38841,16 @@ "basicAuth": [] } ], - "summary": "Get a Publish Topic Exception object.", + "summary": "Get a Message VPN object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "msgVpn" ], "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions": { - "get": { - "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\npublishTopicException|x\npublishTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", - "operationId": "getMsgVpnAclProfilePublishTopicExceptions", + }, + "patch": { + "description": "Update a Message VPN object. Any attribute missing from the request will be left unchanged.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\npreferIpVersion|||||x|\nreplicationBridgeAuthenticationBasicPassword|||x|||x\nreplicationBridgeAuthenticationClientCertContent|||x|||x\nreplicationBridgeAuthenticationClientCertPassword|||x|||\nreplicationEnabledQueueBehavior|||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\nserviceAmqpPlainTextListenPort||||x||\nserviceAmqpTlsListenPort||||x||\nserviceMqttPlainTextListenPort||||x||\nserviceMqttTlsListenPort||||x||\nserviceMqttTlsWebSocketListenPort||||x||\nserviceMqttWebSocketListenPort||||x||\nserviceRestIncomingPlainTextListenPort||||x||\nserviceRestIncomingTlsListenPort||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusLegacyShowClearEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -41887,27 +38860,17 @@ "type": "string" }, { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", + "description": "The Message VPN object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" + "schema": { + "$ref": "#/definitions/MsgVpn" + } }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -41920,9 +38883,9 @@ ], "responses": { "200": { - "description": "The list of Publish Topic Exception objects' attributes, and the request metadata.", + "description": "The Message VPN object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionsResponse" + "$ref": "#/definitions/MsgVpnResponse" } }, "default": { @@ -41937,17 +38900,16 @@ "basicAuth": [] } ], - "summary": "Get a list of Publish Topic Exception objects.", + "summary": "Update a Message VPN object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "msgVpn" ], "x-supportedInSempDirect": false }, - "post": { - "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\npublishTopicException|x|x|x|\npublishTopicExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "createMsgVpnAclProfilePublishTopicException", + "put": { + "description": "Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\npreferIpVersion|||||x|\nreplicationBridgeAuthenticationBasicPassword|||x|||x\nreplicationBridgeAuthenticationClientCertContent|||x|||x\nreplicationBridgeAuthenticationClientCertPassword|||x|||\nreplicationEnabledQueueBehavior|||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\nserviceAmqpPlainTextListenPort||||x||\nserviceAmqpTlsListenPort||||x||\nserviceMqttPlainTextListenPort||||x||\nserviceMqttTlsListenPort||||x||\nserviceMqttTlsWebSocketListenPort||||x||\nserviceMqttWebSocketListenPort||||x||\nserviceRestIncomingPlainTextListenPort||||x||\nserviceRestIncomingTlsListenPort||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusLegacyShowClearEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -41957,19 +38919,12 @@ "type": "string" }, { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Publish Topic Exception object's attributes.", + "description": "The Message VPN object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" + "$ref": "#/definitions/MsgVpn" } }, { @@ -41987,9 +38942,9 @@ ], "responses": { "200": { - "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", + "description": "The Message VPN object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" + "$ref": "#/definitions/MsgVpnResponse" } }, "default": { @@ -42004,19 +38959,18 @@ "basicAuth": [] } ], - "summary": "Create a Publish Topic Exception object.", + "summary": "Replace a Message VPN object.", "tags": [ "all", - "msgVpn", - "aclProfile" + "msgVpn" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}": { - "delete": { - "description": "Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "deleteMsgVpnAclProfilePublishTopicException", + "/msgVpns/{msgVpnName}/aclProfiles": { + "get": { + "description": "Get a list of ACL Profile objects.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfiles", "parameters": [ { "description": "The name of the Message VPN.", @@ -42026,25 +38980,22 @@ "type": "string" }, { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" }, { - "description": "The syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "publishTopicExceptionSyntax", - "required": true, - "type": "string" + "$ref": "#/parameters/cursorQuery" }, { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "publishTopicException", - "required": true, - "type": "string" + "$ref": "#/parameters/forceFullPageQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -42055,9 +39006,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The list of ACL Profile objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnAclProfilesResponse" } }, "default": { @@ -42072,7 +39023,7 @@ "basicAuth": [] } ], - "summary": "Delete a Publish Topic Exception object.", + "summary": "Get a list of ACL Profile objects.", "tags": [ "all", "msgVpn", @@ -42080,9 +39031,9 @@ ], "x-supportedInSempDirect": false }, - "get": { - "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\npublishTopicException|x\npublishTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "getMsgVpnAclProfilePublishTopicException", + "post": { + "description": "Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnAclProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -42092,25 +39043,13 @@ "type": "string" }, { - "description": "The name of the ACL Profile.", - "in": "path", - "name": "aclProfileName", - "required": true, - "type": "string" - }, - { - "description": "The syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "publishTopicExceptionSyntax", - "required": true, - "type": "string" - }, - { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "publishTopicException", + "description": "The ACL Profile object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MsgVpnAclProfile" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -42127,9 +39066,9 @@ ], "responses": { "200": { - "description": "The Publish Topic Exception object's attributes, and the request metadata.", + "description": "The ACL Profile object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" + "$ref": "#/definitions/MsgVpnAclProfileResponse" } }, "default": { @@ -42144,7 +39083,7 @@ "basicAuth": [] } ], - "summary": "Get a Publish Topic Exception object.", + "summary": "Create an ACL Profile object.", "tags": [ "all", "msgVpn", @@ -42153,11 +39092,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions": { - "get": { - "deprecated": true, - "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\nsubscribeExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "operationId": "getMsgVpnAclProfileSubscribeExceptions", + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}": { + "delete": { + "description": "Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnAclProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -42173,24 +39111,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -42200,9 +39120,9 @@ ], "responses": { "200": { - "description": "The list of Subscribe Topic Exception objects' attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionsResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -42217,7 +39137,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Subscribe Topic Exception objects.", + "summary": "Delete an ACL Profile object.", "tags": [ "all", "msgVpn", @@ -42225,10 +39145,9 @@ ], "x-supportedInSempDirect": false }, - "post": { - "deprecated": true, - "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|x\nmsgVpnName|x|||x|x\nsubscribeExceptionTopic|x|x|x||x\ntopicSyntax|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "operationId": "createMsgVpnAclProfileSubscribeException", + "get": { + "description": "Get an ACL Profile object.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -42244,15 +39163,6 @@ "required": true, "type": "string" }, - { - "description": "The Subscribe Topic Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -42268,9 +39178,9 @@ ], "responses": { "200": { - "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", + "description": "The ACL Profile object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" + "$ref": "#/definitions/MsgVpnAclProfileResponse" } }, "default": { @@ -42285,20 +39195,17 @@ "basicAuth": [] } ], - "summary": "Create a Subscribe Topic Exception object.", + "summary": "Get an ACL Profile object.", "tags": [ "all", "msgVpn", "aclProfile" ], "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}": { - "delete": { - "deprecated": true, - "description": "Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "operationId": "deleteMsgVpnAclProfileSubscribeException", + }, + "patch": { + "description": "Update an ACL Profile object. Any attribute missing from the request will be left unchanged.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\naclProfileName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnAclProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -42315,18 +39222,19 @@ "type": "string" }, { - "description": "The syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "topicSyntax", + "description": "The ACL Profile object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MsgVpnAclProfile" + } }, { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "subscribeExceptionTopic", - "required": true, - "type": "string" + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -42337,9 +39245,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The ACL Profile object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnAclProfileResponse" } }, "default": { @@ -42354,7 +39262,7 @@ "basicAuth": [] } ], - "summary": "Delete a Subscribe Topic Exception object.", + "summary": "Update an ACL Profile object.", "tags": [ "all", "msgVpn", @@ -42362,10 +39270,9 @@ ], "x-supportedInSempDirect": false }, - "get": { - "deprecated": true, - "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\nsubscribeExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "operationId": "getMsgVpnAclProfileSubscribeException", + "put": { + "description": "Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\naclProfileName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnAclProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -42382,18 +39289,13 @@ "type": "string" }, { - "description": "The syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "topicSyntax", - "required": true, - "type": "string" - }, - { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "subscribeExceptionTopic", + "description": "The ACL Profile object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MsgVpnAclProfile" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -42410,9 +39312,9 @@ ], "responses": { "200": { - "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", + "description": "The ACL Profile object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" + "$ref": "#/definitions/MsgVpnAclProfileResponse" } }, "default": { @@ -42427,7 +39329,7 @@ "basicAuth": [] } ], - "summary": "Get a Subscribe Topic Exception object.", + "summary": "Replace an ACL Profile object.", "tags": [ "all", "msgVpn", @@ -42436,10 +39338,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions": { "get": { - "description": "Get a list of Subscribe Share Name Exception objects.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeShareNameException|x\nsubscribeShareNameExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", - "operationId": "getMsgVpnAclProfileSubscribeShareNameExceptions", + "description": "Get a list of Client Connect Exception objects.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nclientConnectExceptionAddress|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfileClientConnectExceptions", "parameters": [ { "description": "The name of the Message VPN.", @@ -42482,9 +39384,9 @@ ], "responses": { "200": { - "description": "The list of Subscribe Share Name Exception objects' attributes, and the request metadata.", + "description": "The list of Client Connect Exception objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionsResponse" + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionsResponse" } }, "default": { @@ -42499,7 +39401,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Subscribe Share Name Exception objects.", + "summary": "Get a list of Client Connect Exception objects.", "tags": [ "all", "msgVpn", @@ -42508,8 +39410,8 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\nsubscribeShareNameException|x|x|x|\nsubscribeShareNameExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "createMsgVpnAclProfileSubscribeShareNameException", + "description": "Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nclientConnectExceptionAddress|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnAclProfileClientConnectException", "parameters": [ { "description": "The name of the Message VPN.", @@ -42526,12 +39428,12 @@ "type": "string" }, { - "description": "The Subscribe Share Name Exception object's attributes.", + "description": "The Client Connect Exception object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" + "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" } }, { @@ -42549,9 +39451,9 @@ ], "responses": { "200": { - "description": "The Subscribe Share Name Exception object's attributes after being created, and the request metadata.", + "description": "The Client Connect Exception object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" } }, "default": { @@ -42566,7 +39468,7 @@ "basicAuth": [] } ], - "summary": "Create a Subscribe Share Name Exception object.", + "summary": "Create a Client Connect Exception object.", "tags": [ "all", "msgVpn", @@ -42575,10 +39477,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}": { "delete": { - "description": "Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "deleteMsgVpnAclProfileSubscribeShareNameException", + "description": "Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnAclProfileClientConnectException", "parameters": [ { "description": "The name of the Message VPN.", @@ -42595,16 +39497,9 @@ "type": "string" }, { - "description": "The syntax of the subscribe share name for the exception to the default action taken.", - "in": "path", - "name": "subscribeShareNameExceptionSyntax", - "required": true, - "type": "string" - }, - { - "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", + "description": "The IP address/netmask of the client connect exception in canonical CIDR form.", "in": "path", - "name": "subscribeShareNameException", + "name": "clientConnectExceptionAddress", "required": true, "type": "string" }, @@ -42634,7 +39529,7 @@ "basicAuth": [] } ], - "summary": "Delete a Subscribe Share Name Exception object.", + "summary": "Delete a Client Connect Exception object.", "tags": [ "all", "msgVpn", @@ -42643,8 +39538,8 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Subscribe Share Name Exception object.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeShareNameException|x\nsubscribeShareNameExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "getMsgVpnAclProfileSubscribeShareNameException", + "description": "Get a Client Connect Exception object.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nclientConnectExceptionAddress|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfileClientConnectException", "parameters": [ { "description": "The name of the Message VPN.", @@ -42661,16 +39556,9 @@ "type": "string" }, { - "description": "The syntax of the subscribe share name for the exception to the default action taken.", - "in": "path", - "name": "subscribeShareNameExceptionSyntax", - "required": true, - "type": "string" - }, - { - "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", + "description": "The IP address/netmask of the client connect exception in canonical CIDR form.", "in": "path", - "name": "subscribeShareNameException", + "name": "clientConnectExceptionAddress", "required": true, "type": "string" }, @@ -42689,9 +39577,9 @@ ], "responses": { "200": { - "description": "The Subscribe Share Name Exception object's attributes, and the request metadata.", + "description": "The Client Connect Exception object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" } }, "default": { @@ -42706,7 +39594,7 @@ "basicAuth": [] } ], - "summary": "Get a Subscribe Share Name Exception object.", + "summary": "Get a Client Connect Exception object.", "tags": [ "all", "msgVpn", @@ -42715,10 +39603,11 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions": { "get": { - "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeTopicException|x\nsubscribeTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", - "operationId": "getMsgVpnAclProfileSubscribeTopicExceptions", + "deprecated": true, + "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\npublishExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "getMsgVpnAclProfilePublishExceptions", "parameters": [ { "description": "The name of the Message VPN.", @@ -42761,9 +39650,9 @@ ], "responses": { "200": { - "description": "The list of Subscribe Topic Exception objects' attributes, and the request metadata.", + "description": "The list of Publish Topic Exception objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionsResponse" + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionsResponse" } }, "default": { @@ -42778,7 +39667,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Subscribe Topic Exception objects.", + "summary": "Get a list of Publish Topic Exception objects.", "tags": [ "all", "msgVpn", @@ -42787,8 +39676,9 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\nsubscribeTopicException|x|x|x|\nsubscribeTopicExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "createMsgVpnAclProfileSubscribeTopicException", + "deprecated": true, + "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|x\nmsgVpnName|x|||x|x\npublishExceptionTopic|x|x|x||x\ntopicSyntax|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "createMsgVpnAclProfilePublishException", "parameters": [ { "description": "The name of the Message VPN.", @@ -42805,12 +39695,12 @@ "type": "string" }, { - "description": "The Subscribe Topic Exception object's attributes.", + "description": "The Publish Topic Exception object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" + "$ref": "#/definitions/MsgVpnAclProfilePublishException" } }, { @@ -42828,9 +39718,9 @@ ], "responses": { "200": { - "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", + "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" } }, "default": { @@ -42845,7 +39735,7 @@ "basicAuth": [] } ], - "summary": "Create a Subscribe Topic Exception object.", + "summary": "Create a Publish Topic Exception object.", "tags": [ "all", "msgVpn", @@ -42854,10 +39744,11 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}": { "delete": { - "description": "Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "deleteMsgVpnAclProfileSubscribeTopicException", + "deprecated": true, + "description": "Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "deleteMsgVpnAclProfilePublishException", "parameters": [ { "description": "The name of the Message VPN.", @@ -42876,14 +39767,14 @@ { "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "subscribeTopicExceptionSyntax", + "name": "topicSyntax", "required": true, "type": "string" }, { "description": "The topic for the exception to the default action taken. May include wildcard characters.", "in": "path", - "name": "subscribeTopicException", + "name": "publishExceptionTopic", "required": true, "type": "string" }, @@ -42913,7 +39804,7 @@ "basicAuth": [] } ], - "summary": "Delete a Subscribe Topic Exception object.", + "summary": "Delete a Publish Topic Exception object.", "tags": [ "all", "msgVpn", @@ -42922,8 +39813,9 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeTopicException|x\nsubscribeTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", - "operationId": "getMsgVpnAclProfileSubscribeTopicException", + "deprecated": true, + "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\npublishExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "getMsgVpnAclProfilePublishException", "parameters": [ { "description": "The name of the Message VPN.", @@ -42942,14 +39834,14 @@ { "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "subscribeTopicExceptionSyntax", + "name": "topicSyntax", "required": true, "type": "string" }, { "description": "The topic for the exception to the default action taken. May include wildcard characters.", "in": "path", - "name": "subscribeTopicException", + "name": "publishExceptionTopic", "required": true, "type": "string" }, @@ -42968,9 +39860,9 @@ ], "responses": { "200": { - "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", + "description": "The Publish Topic Exception object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" } }, "default": { @@ -42985,7 +39877,7 @@ "basicAuth": [] } ], - "summary": "Get a Subscribe Topic Exception object.", + "summary": "Get a Publish Topic Exception object.", "tags": [ "all", "msgVpn", @@ -42994,10 +39886,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions": { "get": { - "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfiles", + "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\npublishTopicException|x\npublishTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfilePublishTopicExceptions", "parameters": [ { "description": "The name of the Message VPN.", @@ -43006,6 +39898,13 @@ "required": true, "type": "string" }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/countQuery" }, @@ -43033,9 +39932,9 @@ ], "responses": { "200": { - "description": "The list of OAuth Profile objects' attributes, and the request metadata.", + "description": "The list of Publish Topic Exception objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfilesResponse" + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionsResponse" } }, "default": { @@ -43050,17 +39949,17 @@ "basicAuth": [] } ], - "summary": "Get a list of OAuth Profile objects.", + "summary": "Get a list of Publish Topic Exception objects.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret|||||x|x\nmsgVpnName|x|||x||\noauthProfileName|x|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "createMsgVpnAuthenticationOauthProfile", + "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\npublishTopicException|x|x|x|\npublishTopicExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnAclProfilePublishTopicException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43070,12 +39969,19 @@ "type": "string" }, { - "description": "The OAuth Profile object's attributes.", + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Publish Topic Exception object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" } }, { @@ -43093,9 +39999,9 @@ ], "responses": { "200": { - "description": "The OAuth Profile object's attributes after being created, and the request metadata.", + "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" } }, "default": { @@ -43110,19 +40016,19 @@ "basicAuth": [] } ], - "summary": "Create an OAuth Profile object.", + "summary": "Create a Publish Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}": { "delete": { - "description": "Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "deleteMsgVpnAuthenticationOauthProfile", + "description": "Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnAclProfilePublishTopicException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43132,70 +40038,26 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete an OAuth Profile object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "msgVpnName", + "name": "publishTopicExceptionSyntax", "required": true, "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The topic for the exception to the default action taken. May include wildcard characters.", "in": "path", - "name": "oauthProfileName", + "name": "publishTopicException", "required": true, "type": "string" }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -43205,9 +40067,9 @@ ], "responses": { "200": { - "description": "The OAuth Profile object's attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -43222,17 +40084,17 @@ "basicAuth": [] } ], - "summary": "Get an OAuth Profile object.", + "summary": "Delete a Publish Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, - "patch": { - "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "updateMsgVpnAuthenticationOauthProfile", + "get": { + "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\npublishTopicException|x\npublishTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfilePublishTopicException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43242,88 +40104,26 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The OAuth Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OAuth Profile object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an OAuth Profile object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "put": { - "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "replaceMsgVpnAuthenticationOauthProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "msgVpnName", + "name": "publishTopicExceptionSyntax", "required": true, "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The topic for the exception to the default action taken. May include wildcard characters.", "in": "path", - "name": "oauthProfileName", + "name": "publishTopicException", "required": true, "type": "string" }, - { - "description": "The OAuth Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -43339,9 +40139,9 @@ ], "responses": { "200": { - "description": "The OAuth Profile object's attributes after being replaced, and the request metadata.", + "description": "The Publish Topic Exception object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" } }, "default": { @@ -43356,19 +40156,20 @@ "basicAuth": [] } ], - "summary": "Replace an OAuth Profile object.", + "summary": "Get a Publish Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaims", + "deprecated": true, + "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\nsubscribeExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "getMsgVpnAclProfileSubscribeExceptions", "parameters": [ { "description": "The name of the Message VPN.", @@ -43378,9 +40179,9 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, @@ -43411,9 +40212,9 @@ ], "responses": { "200": { - "description": "The list of Required Claim objects' attributes, and the request metadata.", + "description": "The list of Subscribe Topic Exception objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionsResponse" } }, "default": { @@ -43428,17 +40229,18 @@ "basicAuth": [] } ], - "summary": "Get a list of Required Claim objects.", + "summary": "Get a list of Subscribe Topic Exception objects.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x|\nclientRequiredClaimValue||x|x|\nmsgVpnName|x|||x\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "createMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "deprecated": true, + "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|x\nmsgVpnName|x|||x|x\nsubscribeExceptionTopic|x|x|x||x\ntopicSyntax|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "createMsgVpnAclProfileSubscribeException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43448,19 +40250,19 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The Required Claim object's attributes.", + "description": "The Subscribe Topic Exception object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" } }, { @@ -43478,9 +40280,9 @@ ], "responses": { "200": { - "description": "The Required Claim object's attributes after being created, and the request metadata.", + "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" } }, "default": { @@ -43495,19 +40297,20 @@ "basicAuth": [] } ], - "summary": "Create a Required Claim object.", + "summary": "Create a Subscribe Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}": { "delete": { - "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "deprecated": true, + "description": "Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "deleteMsgVpnAclProfileSubscribeException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43517,16 +40320,23 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The name of the ID token claim to verify.", + "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "clientRequiredClaimName", + "name": "topicSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeExceptionTopic", "required": true, "type": "string" }, @@ -43556,17 +40366,18 @@ "basicAuth": [] } ], - "summary": "Delete a Required Claim object.", + "summary": "Delete a Subscribe Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "deprecated": true, + "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\nsubscribeExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "getMsgVpnAclProfileSubscribeException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43576,16 +40387,23 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The name of the ID token claim to verify.", + "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "clientRequiredClaimName", + "name": "topicSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeExceptionTopic", "required": true, "type": "string" }, @@ -43604,9 +40422,9 @@ ], "responses": { "200": { - "description": "The Required Claim object's attributes, and the request metadata.", + "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" } }, "default": { @@ -43621,19 +40439,19 @@ "basicAuth": [] } ], - "summary": "Get a Required Claim object.", + "summary": "Get a Subscribe Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims", + "description": "Get a list of Subscribe Share Name Exception objects.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeShareNameException|x\nsubscribeShareNameExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeShareNameExceptions", "parameters": [ { "description": "The name of the Message VPN.", @@ -43643,9 +40461,9 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, @@ -43676,9 +40494,9 @@ ], "responses": { "200": { - "description": "The list of Required Claim objects' attributes, and the request metadata.", + "description": "The list of Subscribe Share Name Exception objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionsResponse" } }, "default": { @@ -43693,17 +40511,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Required Claim objects.", + "summary": "Get a list of Subscribe Share Name Exception objects.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\noauthProfileName|x|||x\nresourceServerRequiredClaimName|x|x|x|\nresourceServerRequiredClaimValue||x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", + "description": "Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\nsubscribeShareNameException|x|x|x|\nsubscribeShareNameExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnAclProfileSubscribeShareNameException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43713,19 +40531,19 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The Required Claim object's attributes.", + "description": "The Subscribe Share Name Exception object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" } }, { @@ -43743,9 +40561,9 @@ ], "responses": { "200": { - "description": "The Required Claim object's attributes after being created, and the request metadata.", + "description": "The Subscribe Share Name Exception object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" } }, "default": { @@ -43760,19 +40578,19 @@ "basicAuth": [] } ], - "summary": "Create a Required Claim object.", + "summary": "Create a Subscribe Share Name Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}": { "delete": { - "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", + "description": "Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnAclProfileSubscribeShareNameException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43782,16 +40600,23 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The name of the access token claim to verify.", + "description": "The syntax of the subscribe share name for the exception to the default action taken.", "in": "path", - "name": "resourceServerRequiredClaimName", + "name": "subscribeShareNameExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeShareNameException", "required": true, "type": "string" }, @@ -43821,17 +40646,17 @@ "basicAuth": [] } ], - "summary": "Delete a Required Claim object.", + "summary": "Delete a Subscribe Share Name Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", + "description": "Get a Subscribe Share Name Exception object.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeShareNameException|x\nsubscribeShareNameExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeShareNameException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43841,16 +40666,23 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProfileName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The name of the access token claim to verify.", + "description": "The syntax of the subscribe share name for the exception to the default action taken.", "in": "path", - "name": "resourceServerRequiredClaimName", + "name": "subscribeShareNameExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeShareNameException", "required": true, "type": "string" }, @@ -43869,9 +40701,9 @@ ], "responses": { "200": { - "description": "The Required Claim object's attributes, and the request metadata.", + "description": "The Subscribe Share Name Exception object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" } }, "default": { @@ -43886,20 +40718,19 @@ "basicAuth": [] } ], - "summary": "Get a Required Claim object.", + "summary": "Get a Subscribe Share Name Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProviders": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions": { "get": { - "deprecated": true, - "description": "Get a list of OAuth Provider objects.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naudienceClaimName|||x|\naudienceClaimSource|||x|\naudienceClaimValue|||x|\naudienceValidationEnabled|||x|\nauthorizationGroupClaimName|||x|\nauthorizationGroupClaimSource|||x|\nauthorizationGroupEnabled|||x|\ndisconnectOnTokenExpirationEnabled|||x|\nenabled|||x|\njwksRefreshInterval|||x|\njwksUri|||x|\nmsgVpnName|x||x|\noauthProviderName|x||x|\ntokenIgnoreTimeLimitsEnabled|||x|\ntokenIntrospectionParameterName|||x|\ntokenIntrospectionPassword||x|x|x\ntokenIntrospectionTimeout|||x|\ntokenIntrospectionUri|||x|\ntokenIntrospectionUsername|||x|\nusernameClaimName|||x|\nusernameClaimSource|||x|\nusernameValidateEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "operationId": "getMsgVpnAuthenticationOauthProviders", + "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeTopicException|x\nsubscribeTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeTopicExceptions", "parameters": [ { "description": "The name of the Message VPN.", @@ -43908,6 +40739,13 @@ "required": true, "type": "string" }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/countQuery" }, @@ -43935,9 +40773,9 @@ ], "responses": { "200": { - "description": "The list of OAuth Provider objects' attributes, and the request metadata.", + "description": "The list of Subscribe Topic Exception objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProvidersResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionsResponse" } }, "default": { @@ -43952,18 +40790,17 @@ "basicAuth": [] } ], - "summary": "Get a list of OAuth Provider objects.", + "summary": "Get a list of Subscribe Topic Exception objects.", "tags": [ "all", "msgVpn", - "authenticationOauthProvider" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "deprecated": true, - "description": "Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName||||||x|\naudienceClaimSource||||||x|\naudienceClaimValue||||||x|\naudienceValidationEnabled||||||x|\nauthorizationGroupClaimName||||||x|\nauthorizationGroupClaimSource||||||x|\nauthorizationGroupEnabled||||||x|\ndisconnectOnTokenExpirationEnabled||||||x|\nenabled||||||x|\njwksRefreshInterval||||||x|\njwksUri||||||x|\nmsgVpnName|x|||x||x|\noauthProviderName|x|x|x|||x|\ntokenIgnoreTimeLimitsEnabled||||||x|\ntokenIntrospectionParameterName||||||x|\ntokenIntrospectionPassword|||||x|x|x\ntokenIntrospectionTimeout||||||x|\ntokenIntrospectionUri||||||x|\ntokenIntrospectionUsername||||||x|\nusernameClaimName||||||x|\nusernameClaimSource||||||x|\nusernameValidateEnabled||||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "operationId": "createMsgVpnAuthenticationOauthProvider", + "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\nsubscribeTopicException|x|x|x|\nsubscribeTopicExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnAclProfileSubscribeTopicException", "parameters": [ { "description": "The name of the Message VPN.", @@ -43973,12 +40810,19 @@ "type": "string" }, { - "description": "The OAuth Provider object's attributes.", + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Subscribe Topic Exception object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" } }, { @@ -43996,9 +40840,9 @@ ], "responses": { "200": { - "description": "The OAuth Provider object's attributes after being created, and the request metadata.", + "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" } }, "default": { @@ -44013,20 +40857,19 @@ "basicAuth": [] } ], - "summary": "Create an OAuth Provider object.", + "summary": "Create a Subscribe Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProvider" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}": { + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}": { "delete": { - "deprecated": true, - "description": "Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "operationId": "deleteMsgVpnAuthenticationOauthProvider", + "description": "Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnAclProfileSubscribeTopicException", "parameters": [ { "description": "The name of the Message VPN.", @@ -44036,71 +40879,26 @@ "type": "string" }, { - "description": "The name of the OAuth Provider.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProviderName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete an OAuth Provider object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProvider" - ], - "x-supportedInSempDirect": true - }, - "get": { - "deprecated": true, - "description": "Get an OAuth Provider object.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naudienceClaimName|||x|\naudienceClaimSource|||x|\naudienceClaimValue|||x|\naudienceValidationEnabled|||x|\nauthorizationGroupClaimName|||x|\nauthorizationGroupClaimSource|||x|\nauthorizationGroupEnabled|||x|\ndisconnectOnTokenExpirationEnabled|||x|\nenabled|||x|\njwksRefreshInterval|||x|\njwksUri|||x|\nmsgVpnName|x||x|\noauthProviderName|x||x|\ntokenIgnoreTimeLimitsEnabled|||x|\ntokenIntrospectionParameterName|||x|\ntokenIntrospectionPassword||x|x|x\ntokenIntrospectionTimeout|||x|\ntokenIntrospectionUri|||x|\ntokenIntrospectionUsername|||x|\nusernameClaimName|||x|\nusernameClaimSource|||x|\nusernameValidateEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "operationId": "getMsgVpnAuthenticationOauthProvider", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "msgVpnName", + "name": "subscribeTopicExceptionSyntax", "required": true, "type": "string" }, { - "description": "The name of the OAuth Provider.", + "description": "The topic for the exception to the default action taken. May include wildcard characters.", "in": "path", - "name": "oauthProviderName", + "name": "subscribeTopicException", "required": true, "type": "string" }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -44110,9 +40908,9 @@ ], "responses": { "200": { - "description": "The OAuth Provider object's attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -44127,18 +40925,17 @@ "basicAuth": [] } ], - "summary": "Get an OAuth Provider object.", + "summary": "Delete a Subscribe Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProvider" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, - "patch": { - "deprecated": true, - "description": "Update an OAuth Provider object. Any attribute missing from the request will be left unchanged.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x||x||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword||||x|x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "operationId": "updateMsgVpnAuthenticationOauthProvider", + "get": { + "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeTopicException|x\nsubscribeTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeTopicException", "parameters": [ { "description": "The name of the Message VPN.", @@ -44148,89 +40945,26 @@ "type": "string" }, { - "description": "The name of the OAuth Provider.", + "description": "The name of the ACL Profile.", "in": "path", - "name": "oauthProviderName", + "name": "aclProfileName", "required": true, "type": "string" }, { - "description": "The OAuth Provider object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OAuth Provider object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an OAuth Provider object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProvider" - ], - "x-supportedInSempDirect": true - }, - "put": { - "deprecated": true, - "description": "Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x||x||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword||||x|x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "operationId": "replaceMsgVpnAuthenticationOauthProvider", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The syntax of the topic for the exception to the default action taken.", "in": "path", - "name": "msgVpnName", + "name": "subscribeTopicExceptionSyntax", "required": true, "type": "string" }, { - "description": "The name of the OAuth Provider.", + "description": "The topic for the exception to the default action taken. May include wildcard characters.", "in": "path", - "name": "oauthProviderName", + "name": "subscribeTopicException", "required": true, "type": "string" }, - { - "description": "The OAuth Provider object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -44246,9 +40980,9 @@ ], "responses": { "200": { - "description": "The OAuth Provider object's attributes after being replaced, and the request metadata.", + "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" } }, "default": { @@ -44263,19 +40997,19 @@ "basicAuth": [] } ], - "summary": "Replace an OAuth Provider object.", + "summary": "Get a Subscribe Topic Exception object.", "tags": [ "all", "msgVpn", - "authenticationOauthProvider" + "aclProfile" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authorizationGroups": { + "/msgVpns/{msgVpnName}/authenticationOauthProfiles": { "get": { - "description": "Get a list of Authorization Group objects.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorizationGroupName|x|\nmsgVpnName|x|\norderAfterAuthorizationGroupName||x\norderBeforeAuthorizationGroupName||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnAuthorizationGroups", + "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfiles", "parameters": [ { "description": "The name of the Message VPN.", @@ -44311,9 +41045,9 @@ ], "responses": { "200": { - "description": "The list of Authorization Group objects' attributes, and the request metadata.", + "description": "The list of OAuth Profile objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupsResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfilesResponse" } }, "default": { @@ -44328,17 +41062,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Authorization Group objects.", + "summary": "Get a list of OAuth Profile objects.", "tags": [ "all", "msgVpn", - "authorizationGroup" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { - "description": "Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only\n:---|:---:|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|x|x||\nmsgVpnName|x|||x|\norderAfterAuthorizationGroupName|||||x\norderBeforeAuthorizationGroupName|||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnAuthorizationGroup", + "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret|||||x|x\nmsgVpnName|x|||x||\noauthProfileName|x|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -44348,12 +41082,12 @@ "type": "string" }, { - "description": "The Authorization Group object's attributes.", + "description": "The OAuth Profile object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" } }, { @@ -44371,9 +41105,9 @@ ], "responses": { "200": { - "description": "The Authorization Group object's attributes after being created, and the request metadata.", + "description": "The OAuth Profile object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" } }, "default": { @@ -44388,19 +41122,19 @@ "basicAuth": [] } ], - "summary": "Create an Authorization Group object.", + "summary": "Create an OAuth Profile object.", "tags": [ "all", "msgVpn", - "authorizationGroup" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}": { + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}": { "delete": { - "description": "Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnAuthorizationGroup", + "description": "Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "deleteMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -44410,9 +41144,9 @@ "type": "string" }, { - "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "authorizationGroupName", + "name": "oauthProfileName", "required": true, "type": "string" }, @@ -44442,17 +41176,17 @@ "basicAuth": [] } ], - "summary": "Delete an Authorization Group object.", + "summary": "Delete an OAuth Profile object.", "tags": [ "all", "msgVpn", - "authorizationGroup" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { - "description": "Get an Authorization Group object.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorizationGroupName|x|\nmsgVpnName|x|\norderAfterAuthorizationGroupName||x\norderBeforeAuthorizationGroupName||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnAuthorizationGroup", + "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -44462,9 +41196,9 @@ "type": "string" }, { - "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "authorizationGroupName", + "name": "oauthProfileName", "required": true, "type": "string" }, @@ -44483,9 +41217,9 @@ ], "responses": { "200": { - "description": "The Authorization Group object's attributes, and the request metadata.", + "description": "The OAuth Profile object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" } }, "default": { @@ -44500,17 +41234,17 @@ "basicAuth": [] } ], - "summary": "Get an Authorization Group object.", + "summary": "Get an OAuth Profile object.", "tags": [ "all", "msgVpn", - "authorizationGroup" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "patch": { - "description": "Update an Authorization Group object. Any attribute missing from the request will be left unchanged.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x\nauthorizationGroupName|x|x|||\nclientProfileName|||||x\nmsgVpnName|x||x||\norderAfterAuthorizationGroupName||||x|\norderBeforeAuthorizationGroupName||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "updateMsgVpnAuthorizationGroup", + "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "updateMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -44520,19 +41254,19 @@ "type": "string" }, { - "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "authorizationGroupName", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The Authorization Group object's attributes.", + "description": "The OAuth Profile object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" } }, { @@ -44550,9 +41284,9 @@ ], "responses": { "200": { - "description": "The Authorization Group object's attributes after being updated, and the request metadata.", + "description": "The OAuth Profile object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" } }, "default": { @@ -44567,17 +41301,17 @@ "basicAuth": [] } ], - "summary": "Update an Authorization Group object.", + "summary": "Update an OAuth Profile object.", "tags": [ "all", "msgVpn", - "authorizationGroup" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "put": { - "description": "Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x\nauthorizationGroupName|x|x|||\nclientProfileName|||||x\nmsgVpnName|x||x||\norderAfterAuthorizationGroupName||||x|\norderBeforeAuthorizationGroupName||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "replaceMsgVpnAuthorizationGroup", + "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "replaceMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -44587,19 +41321,19 @@ "type": "string" }, { - "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "authorizationGroupName", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The Authorization Group object's attributes.", + "description": "The OAuth Profile object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" } }, { @@ -44617,9 +41351,9 @@ ], "responses": { "200": { - "description": "The Authorization Group object's attributes after being replaced, and the request metadata.", + "description": "The OAuth Profile object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" } }, "default": { @@ -44634,19 +41368,19 @@ "basicAuth": [] } ], - "summary": "Replace an Authorization Group object.", + "summary": "Replace an OAuth Profile object.", "tags": [ "all", "msgVpn", - "authorizationGroup" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/bridges": { + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims": { "get": { - "description": "Get a list of Bridge objects.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\nremoteAuthenticationBasicPassword||x|x\nremoteAuthenticationClientCertContent||x|x\nremoteAuthenticationClientCertPassword||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnBridges", + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaims", "parameters": [ { "description": "The name of the Message VPN.", @@ -44655,6 +41389,13 @@ "required": true, "type": "string" }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/countQuery" }, @@ -44682,9 +41423,9 @@ ], "responses": { "200": { - "description": "The list of Bridge objects' attributes, and the request metadata.", + "description": "The list of Required Claim objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgesResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse" } }, "default": { @@ -44699,17 +41440,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Bridge objects.", + "summary": "Get a list of Required Claim objects.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { - "description": "Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x|x|||\nbridgeVirtualRouter|x|x|x|||\nmsgVpnName|x|||x||\nremoteAuthenticationBasicPassword|||||x|x\nremoteAuthenticationClientCertContent|||||x|x\nremoteAuthenticationClientCertPassword|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnBridge", + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x|\nclientRequiredClaimValue||x|x|\nmsgVpnName|x|||x\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfileClientRequiredClaim", "parameters": [ { "description": "The name of the Message VPN.", @@ -44719,12 +41460,19 @@ "type": "string" }, { - "description": "The Bridge object's attributes.", + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Required Claim object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnBridge" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" } }, { @@ -44742,9 +41490,9 @@ ], "responses": { "200": { - "description": "The Bridge object's attributes after being created, and the request metadata.", + "description": "The Required Claim object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" } }, "default": { @@ -44759,19 +41507,19 @@ "basicAuth": [] } ], - "summary": "Create a Bridge object.", + "summary": "Create a Required Claim object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}": { + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { "delete": { - "description": "Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnBridge", + "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim", "parameters": [ { "description": "The name of the Message VPN.", @@ -44781,16 +41529,16 @@ "type": "string" }, { - "description": "The name of the Bridge.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "bridgeName", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The virtual router of the Bridge.", + "description": "The name of the ID token claim to verify.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "clientRequiredClaimName", "required": true, "type": "string" }, @@ -44820,17 +41568,17 @@ "basicAuth": [] } ], - "summary": "Delete a Bridge object.", + "summary": "Delete a Required Claim object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { - "description": "Get a Bridge object.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\nremoteAuthenticationBasicPassword||x|x\nremoteAuthenticationClientCertContent||x|x\nremoteAuthenticationClientCertPassword||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnBridge", + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaim", "parameters": [ { "description": "The name of the Message VPN.", @@ -44840,16 +41588,16 @@ "type": "string" }, { - "description": "The name of the Bridge.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "bridgeName", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The virtual router of the Bridge.", + "description": "The name of the ID token claim to verify.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "clientRequiredClaimName", "required": true, "type": "string" }, @@ -44868,9 +41616,9 @@ ], "responses": { "200": { - "description": "The Bridge object's attributes, and the request metadata.", + "description": "The Required Claim object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" } }, "default": { @@ -44885,17 +41633,19 @@ "basicAuth": [] } ], - "summary": "Get a Bridge object.", + "summary": "Get a Required Claim object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Bridge object. Any attribute missing from the request will be left unchanged.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmaxTtl|||||x|\nmsgVpnName|x||x|||\nremoteAuthenticationBasicClientUsername|||||x|\nremoteAuthenticationBasicPassword||||x|x|x\nremoteAuthenticationClientCertContent||||x|x|x\nremoteAuthenticationClientCertPassword||||x|x|\nremoteAuthenticationScheme|||||x|\nremoteDeliverToOnePriority|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "updateMsgVpnBridge", + "x-supportedInSempDirect": true + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { + "get": { + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims", "parameters": [ { "description": "The name of the Message VPN.", @@ -44905,31 +41655,27 @@ "type": "string" }, { - "description": "The name of the Bridge.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "bridgeName", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" }, { - "description": "The Bridge object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridge" - } + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" }, { "$ref": "#/parameters/opaquePasswordQuery" }, + { + "$ref": "#/parameters/whereQuery" + }, { "$ref": "#/parameters/selectQuery" }, @@ -44942,9 +41688,9 @@ ], "responses": { "200": { - "description": "The Bridge object's attributes after being updated, and the request metadata.", + "description": "The list of Required Claim objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse" } }, "default": { @@ -44959,17 +41705,17 @@ "basicAuth": [] } ], - "summary": "Update a Bridge object.", + "summary": "Get a list of Required Claim objects.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "put": { - "description": "Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmaxTtl|||||x|\nmsgVpnName|x||x|||\nremoteAuthenticationBasicClientUsername|||||x|\nremoteAuthenticationBasicPassword||||x|x|x\nremoteAuthenticationClientCertContent||||x|x|x\nremoteAuthenticationClientCertPassword||||x|x|\nremoteAuthenticationScheme|||||x|\nremoteDeliverToOnePriority|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "replaceMsgVpnBridge", + "post": { + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\noauthProfileName|x|||x\nresourceServerRequiredClaimName|x|x|x|\nresourceServerRequiredClaimValue||x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", "parameters": [ { "description": "The name of the Message VPN.", @@ -44979,26 +41725,19 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The Bridge object's attributes.", + "description": "The Required Claim object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnBridge" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" } }, { @@ -45016,9 +41755,9 @@ ], "responses": { "200": { - "description": "The Bridge object's attributes after being replaced, and the request metadata.", + "description": "The Required Claim object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" } }, "default": { @@ -45033,19 +41772,19 @@ "basicAuth": [] } ], - "summary": "Replace a Bridge object.", + "summary": "Create a Required Claim object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns": { - "get": { - "description": "Get a list of Remote Message VPN objects.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\npassword||x|x\nremoteMsgVpnInterface|x||\nremoteMsgVpnLocation|x||\nremoteMsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnBridgeRemoteMsgVpns", + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}": { + "delete": { + "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", "parameters": [ { "description": "The name of the Message VPN.", @@ -45055,28 +41794,19 @@ "type": "string" }, { - "description": "The name of the Bridge.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "bridgeName", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The virtual router of the Bridge.", + "description": "The name of the access token claim to verify.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "resourceServerRequiredClaimName", "required": true, "type": "string" }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -45086,9 +41816,9 @@ ], "responses": { "200": { - "description": "The list of Remote Message VPN objects' attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnsResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -45103,17 +41833,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Remote Message VPN objects.", + "summary": "Delete a Required Claim object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "post": { - "description": "Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x||\nbridgeVirtualRouter|x|||x||\nmsgVpnName|x|||x||\npassword|||||x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x|x|||\nremoteMsgVpnName|x|x|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnBridgeRemoteMsgVpn", + "get": { + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", "parameters": [ { "description": "The name of the Message VPN.", @@ -45123,28 +41853,19 @@ "type": "string" }, { - "description": "The name of the Bridge.", + "description": "The name of the OAuth profile.", "in": "path", - "name": "bridgeName", + "name": "oauthProfileName", "required": true, "type": "string" }, { - "description": "The virtual router of the Bridge.", + "description": "The name of the access token claim to verify.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "resourceServerRequiredClaimName", "required": true, "type": "string" }, - { - "description": "The Remote Message VPN object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -45160,9 +41881,9 @@ ], "responses": { "200": { - "description": "The Remote Message VPN object's attributes after being created, and the request metadata.", + "description": "The Required Claim object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" } }, "default": { @@ -45177,19 +41898,20 @@ "basicAuth": [] } ], - "summary": "Create a Remote Message VPN object.", + "summary": "Get a Required Claim object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProfile" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}": { - "delete": { - "description": "Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnBridgeRemoteMsgVpn", + "/msgVpns/{msgVpnName}/authenticationOauthProviders": { + "get": { + "deprecated": true, + "description": "Get a list of OAuth Provider objects.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naudienceClaimName|||x|\naudienceClaimSource|||x|\naudienceClaimValue|||x|\naudienceValidationEnabled|||x|\nauthorizationGroupClaimName|||x|\nauthorizationGroupClaimSource|||x|\nauthorizationGroupEnabled|||x|\ndisconnectOnTokenExpirationEnabled|||x|\nenabled|||x|\njwksRefreshInterval|||x|\njwksUri|||x|\nmsgVpnName|x||x|\noauthProviderName|x||x|\ntokenIgnoreTimeLimitsEnabled|||x|\ntokenIntrospectionParameterName|||x|\ntokenIntrospectionPassword||x|x|x\ntokenIntrospectionTimeout|||x|\ntokenIntrospectionUri|||x|\ntokenIntrospectionUsername|||x|\nusernameClaimName|||x|\nusernameClaimSource|||x|\nusernameValidateEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "getMsgVpnAuthenticationOauthProviders", "parameters": [ { "description": "The name of the Message VPN.", @@ -45199,39 +41921,22 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" }, { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", - "required": true, - "type": "string" + "$ref": "#/parameters/cursorQuery" }, { - "description": "The name of the remote Message VPN.", - "in": "path", - "name": "remoteMsgVpnName", - "required": true, - "type": "string" + "$ref": "#/parameters/forceFullPageQuery" }, { - "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", - "in": "path", - "name": "remoteMsgVpnLocation", - "required": true, - "type": "string" + "$ref": "#/parameters/opaquePasswordQuery" }, { - "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", - "in": "path", - "name": "remoteMsgVpnInterface", - "required": true, - "type": "string" + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -45242,9 +41947,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The list of OAuth Provider objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvidersResponse" } }, "default": { @@ -45259,17 +41964,18 @@ "basicAuth": [] } ], - "summary": "Delete a Remote Message VPN object.", + "summary": "Get a list of OAuth Provider objects.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProvider" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "get": { - "description": "Get a Remote Message VPN object.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\npassword||x|x\nremoteMsgVpnInterface|x||\nremoteMsgVpnLocation|x||\nremoteMsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnBridgeRemoteMsgVpn", + "post": { + "deprecated": true, + "description": "Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName||||||x|\naudienceClaimSource||||||x|\naudienceClaimValue||||||x|\naudienceValidationEnabled||||||x|\nauthorizationGroupClaimName||||||x|\nauthorizationGroupClaimSource||||||x|\nauthorizationGroupEnabled||||||x|\ndisconnectOnTokenExpirationEnabled||||||x|\nenabled||||||x|\njwksRefreshInterval||||||x|\njwksUri||||||x|\nmsgVpnName|x|||x||x|\noauthProviderName|x|x|x|||x|\ntokenIgnoreTimeLimitsEnabled||||||x|\ntokenIntrospectionParameterName||||||x|\ntokenIntrospectionPassword|||||x|x|x\ntokenIntrospectionTimeout||||||x|\ntokenIntrospectionUri||||||x|\ntokenIntrospectionUsername||||||x|\nusernameClaimName||||||x|\nusernameClaimSource||||||x|\nusernameValidateEnabled||||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "createMsgVpnAuthenticationOauthProvider", "parameters": [ { "description": "The name of the Message VPN.", @@ -45279,39 +41985,13 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The name of the remote Message VPN.", - "in": "path", - "name": "remoteMsgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", - "in": "path", - "name": "remoteMsgVpnLocation", - "required": true, - "type": "string" - }, - { - "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", - "in": "path", - "name": "remoteMsgVpnInterface", + "description": "The OAuth Provider object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -45328,9 +42008,9 @@ ], "responses": { "200": { - "description": "The Remote Message VPN object's attributes, and the request metadata.", + "description": "The OAuth Provider object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" } }, "default": { @@ -45345,17 +42025,20 @@ "basicAuth": [] } ], - "summary": "Get a Remote Message VPN object.", + "summary": "Create an OAuth Provider object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProvider" ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\nclientUsername|||||x|\ncompressedDataEnabled|||||x|\negressFlowWindowSize|||||x|\nmsgVpnName|x||x|||\npassword||||x|x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "updateMsgVpnBridgeRemoteMsgVpn", + "x-supportedInSempDirect": true + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}": { + "delete": { + "deprecated": true, + "description": "Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "deleteMsgVpnAuthenticationOauthProvider", "parameters": [ { "description": "The name of the Message VPN.", @@ -45365,55 +42048,12 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The name of the remote Message VPN.", - "in": "path", - "name": "remoteMsgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", - "in": "path", - "name": "remoteMsgVpnLocation", - "required": true, - "type": "string" - }, - { - "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "description": "The name of the OAuth Provider.", "in": "path", - "name": "remoteMsgVpnInterface", + "name": "oauthProviderName", "required": true, "type": "string" }, - { - "description": "The Remote Message VPN object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -45423,9 +42063,9 @@ ], "responses": { "200": { - "description": "The Remote Message VPN object's attributes after being updated, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -45440,17 +42080,18 @@ "basicAuth": [] } ], - "summary": "Update a Remote Message VPN object.", + "summary": "Delete an OAuth Provider object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProvider" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "put": { - "description": "Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\nclientUsername|||||x|\ncompressedDataEnabled|||||x|\negressFlowWindowSize|||||x|\nmsgVpnName|x||x|||\npassword||||x|x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "replaceMsgVpnBridgeRemoteMsgVpn", + "get": { + "deprecated": true, + "description": "Get an OAuth Provider object.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naudienceClaimName|||x|\naudienceClaimSource|||x|\naudienceClaimValue|||x|\naudienceValidationEnabled|||x|\nauthorizationGroupClaimName|||x|\nauthorizationGroupClaimSource|||x|\nauthorizationGroupEnabled|||x|\ndisconnectOnTokenExpirationEnabled|||x|\nenabled|||x|\njwksRefreshInterval|||x|\njwksUri|||x|\nmsgVpnName|x||x|\noauthProviderName|x||x|\ntokenIgnoreTimeLimitsEnabled|||x|\ntokenIntrospectionParameterName|||x|\ntokenIntrospectionPassword||x|x|x\ntokenIntrospectionTimeout|||x|\ntokenIntrospectionUri|||x|\ntokenIntrospectionUsername|||x|\nusernameClaimName|||x|\nusernameClaimSource|||x|\nusernameValidateEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "getMsgVpnAuthenticationOauthProvider", "parameters": [ { "description": "The name of the Message VPN.", @@ -45460,49 +42101,12 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The name of the remote Message VPN.", - "in": "path", - "name": "remoteMsgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", - "in": "path", - "name": "remoteMsgVpnLocation", - "required": true, - "type": "string" - }, - { - "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "description": "The name of the OAuth Provider.", "in": "path", - "name": "remoteMsgVpnInterface", + "name": "oauthProviderName", "required": true, "type": "string" }, - { - "description": "The Remote Message VPN object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -45518,9 +42122,9 @@ ], "responses": { "200": { - "description": "The Remote Message VPN object's attributes after being replaced, and the request metadata.", + "description": "The OAuth Provider object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" } }, "default": { @@ -45535,19 +42139,18 @@ "basicAuth": [] } ], - "summary": "Replace a Remote Message VPN object.", + "summary": "Get an OAuth Provider object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProvider" ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions": { - "get": { - "description": "Get a list of Remote Subscription objects.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\nremoteSubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnBridgeRemoteSubscriptions", + "x-supportedInSempDirect": true + }, + "patch": { + "deprecated": true, + "description": "Update an OAuth Provider object. Any attribute missing from the request will be left unchanged.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x||x||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword||||x|x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "updateMsgVpnAuthenticationOauthProvider", "parameters": [ { "description": "The name of the Message VPN.", @@ -45557,34 +42160,24 @@ "type": "string" }, { - "description": "The name of the Bridge.", + "description": "The name of the OAuth Provider.", "in": "path", - "name": "bridgeName", + "name": "oauthProviderName", "required": true, "type": "string" }, { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", + "description": "The OAuth Provider object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + } }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -45597,9 +42190,9 @@ ], "responses": { "200": { - "description": "The list of Remote Subscription objects' attributes, and the request metadata.", + "description": "The OAuth Provider object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionsResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" } }, "default": { @@ -45614,17 +42207,18 @@ "basicAuth": [] } ], - "summary": "Get a list of Remote Subscription objects.", + "summary": "Update an OAuth Provider object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProvider" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "post": { - "description": "Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||x\nbridgeVirtualRouter|x|||x\ndeliverAlwaysEnabled||x|x|\nmsgVpnName|x|||x\nremoteSubscriptionTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnBridgeRemoteSubscription", + "put": { + "deprecated": true, + "description": "Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x||x||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword||||x|x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "replaceMsgVpnAuthenticationOauthProvider", "parameters": [ { "description": "The name of the Message VPN.", @@ -45634,26 +42228,19 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", + "description": "The name of the OAuth Provider.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "oauthProviderName", "required": true, "type": "string" }, { - "description": "The Remote Subscription object's attributes.", + "description": "The OAuth Provider object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" } }, { @@ -45671,9 +42258,9 @@ ], "responses": { "200": { - "description": "The Remote Subscription object's attributes after being created, and the request metadata.", + "description": "The OAuth Provider object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" } }, "default": { @@ -45688,19 +42275,19 @@ "basicAuth": [] } ], - "summary": "Create a Remote Subscription object.", + "summary": "Replace an OAuth Provider object.", "tags": [ "all", "msgVpn", - "bridge" + "authenticationOauthProvider" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}": { - "delete": { - "description": "Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnBridgeRemoteSubscription", + "/msgVpns/{msgVpnName}/authorizationGroups": { + "get": { + "description": "Get a list of Authorization Group objects.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorizationGroupName|x|\nmsgVpnName|x|\norderAfterAuthorizationGroupName||x\norderBeforeAuthorizationGroupName||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAuthorizationGroups", "parameters": [ { "description": "The name of the Message VPN.", @@ -45710,25 +42297,22 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" }, { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", - "required": true, - "type": "string" + "$ref": "#/parameters/cursorQuery" }, { - "description": "The topic of the Bridge remote subscription.", - "in": "path", - "name": "remoteSubscriptionTopic", - "required": true, - "type": "string" + "$ref": "#/parameters/forceFullPageQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -45739,9 +42323,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The list of Authorization Group objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnAuthorizationGroupsResponse" } }, "default": { @@ -45756,17 +42340,17 @@ "basicAuth": [] } ], - "summary": "Delete a Remote Subscription object.", + "summary": "Get a list of Authorization Group objects.", "tags": [ "all", "msgVpn", - "bridge" + "authorizationGroup" ], "x-supportedInSempDirect": false }, - "get": { - "description": "Get a Remote Subscription object.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\nremoteSubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnBridgeRemoteSubscription", + "post": { + "description": "Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only\n:---|:---:|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|x|x||\nmsgVpnName|x|||x|\norderAfterAuthorizationGroupName|||||x\norderBeforeAuthorizationGroupName|||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnAuthorizationGroup", "parameters": [ { "description": "The name of the Message VPN.", @@ -45776,25 +42360,13 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The topic of the Bridge remote subscription.", - "in": "path", - "name": "remoteSubscriptionTopic", + "description": "The Authorization Group object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -45811,9 +42383,9 @@ ], "responses": { "200": { - "description": "The Remote Subscription object's attributes, and the request metadata.", + "description": "The Authorization Group object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" } }, "default": { @@ -45828,20 +42400,19 @@ "basicAuth": [] } ], - "summary": "Get a Remote Subscription object.", + "summary": "Create an Authorization Group object.", "tags": [ "all", "msgVpn", - "bridge" + "authorizationGroup" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames": { - "get": { - "deprecated": true, - "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nbridgeName|x|x\nbridgeVirtualRouter|x|x\nmsgVpnName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "getMsgVpnBridgeTlsTrustedCommonNames", + "/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}": { + "delete": { + "description": "Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnAuthorizationGroup", "parameters": [ { "description": "The name of the Message VPN.", @@ -45851,28 +42422,12 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "authorizationGroupName", "required": true, "type": "string" }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -45882,9 +42437,9 @@ ], "responses": { "200": { - "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNamesResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -45899,18 +42454,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Trusted Common Name objects.", + "summary": "Delete an Authorization Group object.", "tags": [ "all", "msgVpn", - "bridge" + "authorizationGroup" ], "x-supportedInSempDirect": false }, - "post": { - "deprecated": true, - "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x|x\nbridgeVirtualRouter|x|||x|x\nmsgVpnName|x|||x|x\ntlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "createMsgVpnBridgeTlsTrustedCommonName", + "get": { + "description": "Get an Authorization Group object.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorizationGroupName|x|\nmsgVpnName|x|\norderAfterAuthorizationGroupName||x\norderBeforeAuthorizationGroupName||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAuthorizationGroup", "parameters": [ { "description": "The name of the Message VPN.", @@ -45920,28 +42474,12 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "authorizationGroupName", "required": true, "type": "string" }, - { - "description": "The Trusted Common Name object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -45957,9 +42495,9 @@ ], "responses": { "200": { - "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", + "description": "The Authorization Group object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" } }, "default": { @@ -45974,20 +42512,17 @@ "basicAuth": [] } ], - "summary": "Create a Trusted Common Name object.", + "summary": "Get an Authorization Group object.", "tags": [ "all", "msgVpn", - "bridge" + "authorizationGroup" ], "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { - "delete": { - "deprecated": true, - "description": "Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "deleteMsgVpnBridgeTlsTrustedCommonName", + }, + "patch": { + "description": "Update an Authorization Group object. Any attribute missing from the request will be left unchanged.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x\nauthorizationGroupName|x|x|||\nclientProfileName|||||x\nmsgVpnName|x||x||\norderAfterAuthorizationGroupName||||x|\norderBeforeAuthorizationGroupName||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnAuthorizationGroup", "parameters": [ { "description": "The name of the Message VPN.", @@ -45997,25 +42532,26 @@ "type": "string" }, { - "description": "The name of the Bridge.", + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", "in": "path", - "name": "bridgeName", + "name": "authorizationGroupName", "required": true, "type": "string" }, { - "description": "The virtual router of the Bridge.", - "in": "path", - "name": "bridgeVirtualRouter", + "description": "The Authorization Group object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + } }, { - "description": "The expected trusted common name of the remote certificate.", - "in": "path", - "name": "tlsTrustedCommonName", - "required": true, - "type": "string" + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -46026,9 +42562,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The Authorization Group object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" } }, "default": { @@ -46043,18 +42579,17 @@ "basicAuth": [] } ], - "summary": "Delete a Trusted Common Name object.", + "summary": "Update an Authorization Group object.", "tags": [ "all", "msgVpn", - "bridge" + "authorizationGroup" ], "x-supportedInSempDirect": false }, - "get": { - "deprecated": true, - "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nbridgeName|x|x\nbridgeVirtualRouter|x|x\nmsgVpnName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "getMsgVpnBridgeTlsTrustedCommonName", + "put": { + "description": "Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x\nauthorizationGroupName|x|x|||\nclientProfileName|||||x\nmsgVpnName|x||x||\norderAfterAuthorizationGroupName||||x|\norderBeforeAuthorizationGroupName||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnAuthorizationGroup", "parameters": [ { "description": "The name of the Message VPN.", @@ -46064,25 +42599,20 @@ "type": "string" }, { - "description": "The name of the Bridge.", - "in": "path", - "name": "bridgeName", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the Bridge.", + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", "in": "path", - "name": "bridgeVirtualRouter", + "name": "authorizationGroupName", "required": true, "type": "string" }, { - "description": "The expected trusted common name of the remote certificate.", - "in": "path", - "name": "tlsTrustedCommonName", + "description": "The Authorization Group object's attributes.", + "in": "body", + "name": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + } }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -46099,9 +42629,9 @@ ], "responses": { "200": { - "description": "The Trusted Common Name object's attributes, and the request metadata.", + "description": "The Authorization Group object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" } }, "default": { @@ -46116,19 +42646,19 @@ "basicAuth": [] } ], - "summary": "Get a Trusted Common Name object.", + "summary": "Replace an Authorization Group object.", "tags": [ "all", "msgVpn", - "bridge" + "authorizationGroup" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/certMatchingRules": { + "/msgVpns/{msgVpnName}/bridges": { "get": { - "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", - "operationId": "getMsgVpnCertMatchingRules", + "description": "Get a list of Bridge objects.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\nremoteAuthenticationBasicPassword||x|x\nremoteAuthenticationClientCertContent||x|x\nremoteAuthenticationClientCertPassword||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridges", "parameters": [ { "description": "The name of the Message VPN.", @@ -46164,9 +42694,9 @@ ], "responses": { "200": { - "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", + "description": "The list of Bridge objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRulesResponse" + "$ref": "#/definitions/MsgVpnBridgesResponse" } }, "default": { @@ -46181,17 +42711,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Certificate Matching Rule objects.", + "summary": "Get a list of Bridge objects.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nruleName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "createMsgVpnCertMatchingRule", + "description": "Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x|x|||\nbridgeVirtualRouter|x|x|x|||\nmsgVpnName|x|||x||\nremoteAuthenticationBasicPassword|||||x|x\nremoteAuthenticationClientCertContent|||||x|x\nremoteAuthenticationClientCertPassword|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -46201,12 +42731,12 @@ "type": "string" }, { - "description": "The Certificate Matching Rule object's attributes.", + "description": "The Bridge object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" + "$ref": "#/definitions/MsgVpnBridge" } }, { @@ -46224,9 +42754,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", + "description": "The Bridge object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + "$ref": "#/definitions/MsgVpnBridgeResponse" } }, "default": { @@ -46241,19 +42771,19 @@ "basicAuth": [] } ], - "summary": "Create a Certificate Matching Rule object.", + "summary": "Create a Bridge object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}": { + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}": { "delete": { - "description": "Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "deleteMsgVpnCertMatchingRule", + "description": "Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -46263,9 +42793,16 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", "required": true, "type": "string" }, @@ -46295,29 +42832,36 @@ "basicAuth": [] } ], - "summary": "Delete a Certificate Matching Rule object.", + "summary": "Delete a Bridge object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "getMsgVpnCertMatchingRule", + "description": "Get a Bridge object.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\nremoteAuthenticationBasicPassword||x|x\nremoteAuthenticationClientCertContent||x|x\nremoteAuthenticationClientCertPassword||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridge", "parameters": [ { "description": "The name of the Message VPN.", "in": "path", - "name": "msgVpnName", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The name of the rule.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeVirtualRouter", "required": true, "type": "string" }, @@ -46336,9 +42880,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes, and the request metadata.", + "description": "The Bridge object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + "$ref": "#/definitions/MsgVpnBridgeResponse" } }, "default": { @@ -46353,17 +42897,17 @@ "basicAuth": [] } ], - "summary": "Get a Certificate Matching Rule object.", + "summary": "Get a Bridge object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "updateMsgVpnCertMatchingRule", + "description": "Update a Bridge object. Any attribute missing from the request will be left unchanged.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmaxTtl|||||x|\nmsgVpnName|x||x|||\nremoteAuthenticationBasicClientUsername|||||x|\nremoteAuthenticationBasicPassword||||x|x|x\nremoteAuthenticationClientCertContent||||x|x|x\nremoteAuthenticationClientCertPassword||||x|x|\nremoteAuthenticationScheme|||||x|\nremoteDeliverToOnePriority|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -46373,19 +42917,26 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule object's attributes.", + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Bridge object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" + "$ref": "#/definitions/MsgVpnBridge" } }, { @@ -46403,9 +42954,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", + "description": "The Bridge object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + "$ref": "#/definitions/MsgVpnBridgeResponse" } }, "default": { @@ -46420,17 +42971,17 @@ "basicAuth": [] } ], - "summary": "Update a Certificate Matching Rule object.", + "summary": "Update a Bridge object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "replaceMsgVpnCertMatchingRule", + "description": "Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmaxTtl|||||x|\nmsgVpnName|x||x|||\nremoteAuthenticationBasicClientUsername|||||x|\nremoteAuthenticationBasicPassword||||x|x|x\nremoteAuthenticationClientCertContent||||x|x|x\nremoteAuthenticationClientCertPassword||||x|x|\nremoteAuthenticationScheme|||||x|\nremoteDeliverToOnePriority|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -46440,19 +42991,26 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule object's attributes.", + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Bridge object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" + "$ref": "#/definitions/MsgVpnBridge" } }, { @@ -46470,9 +43028,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", + "description": "The Bridge object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + "$ref": "#/definitions/MsgVpnBridgeResponse" } }, "default": { @@ -46487,19 +43045,19 @@ "basicAuth": [] } ], - "summary": "Replace a Certificate Matching Rule object.", + "summary": "Replace a Bridge object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters": { + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns": { "get": { - "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilterName|x\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", - "operationId": "getMsgVpnCertMatchingRuleAttributeFilters", + "description": "Get a list of Remote Message VPN objects.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\npassword||x|x\nremoteMsgVpnInterface|x||\nremoteMsgVpnLocation|x||\nremoteMsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteMsgVpns", "parameters": [ { "description": "The name of the Message VPN.", @@ -46509,20 +43067,18 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" - }, - { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -46542,9 +43098,9 @@ ], "responses": { "200": { - "description": "The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.", + "description": "The list of Remote Message VPN objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFiltersResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnsResponse" } }, "default": { @@ -46559,17 +43115,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", + "summary": "Get a list of Remote Message VPN objects.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nfilterName|x|x|x|\nmsgVpnName|x|||x\nruleName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "createMsgVpnCertMatchingRuleAttributeFilter", + "description": "Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x||\nbridgeVirtualRouter|x|||x||\nmsgVpnName|x|||x||\npassword|||||x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x|x|||\nremoteMsgVpnName|x|x|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnBridgeRemoteMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -46579,19 +43135,26 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Remote Message VPN object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" } }, { @@ -46609,9 +43172,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.", + "description": "The Remote Message VPN object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" } }, "default": { @@ -46626,19 +43189,19 @@ "basicAuth": [] } ], - "summary": "Create a Certificate Matching Rule Attribute Filter object.", + "summary": "Create a Remote Message VPN object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}": { "delete": { - "description": "Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "deleteMsgVpnCertMatchingRuleAttributeFilter", + "description": "Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnBridgeRemoteMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -46648,16 +43211,37 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The name of the filter.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "filterName", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", "required": true, "type": "string" }, @@ -46687,17 +43271,17 @@ "basicAuth": [] } ], - "summary": "Delete a Certificate Matching Rule Attribute Filter object.", + "summary": "Delete a Remote Message VPN object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilterName|x\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "getMsgVpnCertMatchingRuleAttributeFilter", + "description": "Get a Remote Message VPN object.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\npassword||x|x\nremoteMsgVpnInterface|x||\nremoteMsgVpnLocation|x||\nremoteMsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -46707,16 +43291,37 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The name of the filter.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "filterName", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", "required": true, "type": "string" }, @@ -46735,9 +43340,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", + "description": "The Remote Message VPN object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" } }, "default": { @@ -46752,17 +43357,17 @@ "basicAuth": [] } ], - "summary": "Get a Certificate Matching Rule Attribute Filter object.", + "summary": "Get a Remote Message VPN object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nfilterName|x|x|\nmsgVpnName|x||x\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "updateMsgVpnCertMatchingRuleAttributeFilter", + "description": "Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\nclientUsername|||||x|\ncompressedDataEnabled|||||x|\negressFlowWindowSize|||||x|\nmsgVpnName|x||x|||\npassword||||x|x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnBridgeRemoteMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -46772,26 +43377,47 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The name of the filter.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "filterName", + "name": "bridgeVirtualRouter", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", + "required": true, + "type": "string" + }, + { + "description": "The Remote Message VPN object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" } }, { @@ -46809,9 +43435,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.", + "description": "The Remote Message VPN object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" } }, "default": { @@ -46826,17 +43452,17 @@ "basicAuth": [] } ], - "summary": "Update a Certificate Matching Rule Attribute Filter object.", + "summary": "Update a Remote Message VPN object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nfilterName|x|x|\nmsgVpnName|x||x\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", - "operationId": "replaceMsgVpnCertMatchingRuleAttributeFilter", + "description": "Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\nclientUsername|||||x|\ncompressedDataEnabled|||||x|\negressFlowWindowSize|||||x|\nmsgVpnName|x||x|||\npassword||||x|x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnBridgeRemoteMsgVpn", "parameters": [ { "description": "The name of the Message VPN.", @@ -46846,26 +43472,47 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The name of the filter.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "filterName", + "name": "bridgeVirtualRouter", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", + "required": true, + "type": "string" + }, + { + "description": "The Remote Message VPN object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" } }, { @@ -46883,9 +43530,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.", + "description": "The Remote Message VPN object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" } }, "default": { @@ -46900,19 +43547,19 @@ "basicAuth": [] } ], - "summary": "Replace a Certificate Matching Rule Attribute Filter object.", + "summary": "Replace a Remote Message VPN object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions": { + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions": { "get": { - "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", - "operationId": "getMsgVpnCertMatchingRuleConditions", + "description": "Get a list of Remote Subscription objects.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\nremoteSubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteSubscriptions", "parameters": [ { "description": "The name of the Message VPN.", @@ -46922,9 +43569,16 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", "required": true, "type": "string" }, @@ -46955,9 +43609,9 @@ ], "responses": { "200": { - "description": "The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.", + "description": "The list of Remote Subscription objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionsResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionsResponse" } }, "default": { @@ -46972,17 +43626,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Certificate Matching Rule Condition objects.", + "summary": "Get a list of Remote Subscription objects.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattribute||x||\nexpression||x||\nmsgVpnName|x|||x\nruleName|x|||x\nsource|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "createMsgVpnCertMatchingRuleCondition", + "description": "Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||x\nbridgeVirtualRouter|x|||x\ndeliverAlwaysEnabled||x|x|\nmsgVpnName|x|||x\nremoteSubscriptionTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnBridgeRemoteSubscription", "parameters": [ { "description": "The name of the Message VPN.", @@ -46992,19 +43646,26 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The Certificate Matching Rule Condition object's attributes.", + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Remote Subscription object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleCondition" + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" } }, { @@ -47022,9 +43683,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", + "description": "The Remote Subscription object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" } }, "default": { @@ -47039,19 +43700,19 @@ "basicAuth": [] } ], - "summary": "Create a Certificate Matching Rule Condition object.", + "summary": "Create a Remote Subscription object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}": { + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}": { "delete": { - "description": "Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "deleteMsgVpnCertMatchingRuleCondition", + "description": "Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnBridgeRemoteSubscription", "parameters": [ { "description": "The name of the Message VPN.", @@ -47061,16 +43722,23 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "Certificate field to be compared with the Attribute.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "source", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Bridge remote subscription.", + "in": "path", + "name": "remoteSubscriptionTopic", "required": true, "type": "string" }, @@ -47100,17 +43768,17 @@ "basicAuth": [] } ], - "summary": "Delete a Certificate Matching Rule Condition object.", + "summary": "Delete a Remote Subscription object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "getMsgVpnCertMatchingRuleCondition", + "description": "Get a Remote Subscription object.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\nremoteSubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteSubscription", "parameters": [ { "description": "The name of the Message VPN.", @@ -47120,16 +43788,23 @@ "type": "string" }, { - "description": "The name of the rule.", + "description": "The name of the Bridge.", "in": "path", - "name": "ruleName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "Certificate field to be compared with the Attribute.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "source", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Bridge remote subscription.", + "in": "path", + "name": "remoteSubscriptionTopic", "required": true, "type": "string" }, @@ -47148,9 +43823,9 @@ ], "responses": { "200": { - "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", + "description": "The Remote Subscription object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" } }, "default": { @@ -47165,19 +43840,20 @@ "basicAuth": [] } ], - "summary": "Get a Certificate Matching Rule Condition object.", + "summary": "Get a Remote Subscription object.", "tags": [ "all", "msgVpn", - "certMatchingRule" + "bridge" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/clientProfiles": { + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames": { "get": { - "description": "Get a list of Client Profile objects.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallowCutThroughForwardingEnabled||x\napiQueueManagementCopyFromOnCreateName||x\napiTopicEndpointManagementCopyFromOnCreateName||x\nclientProfileName|x|\nmsgVpnName|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnClientProfiles", + "deprecated": true, + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nbridgeName|x|x\nbridgeVirtualRouter|x|x\nmsgVpnName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getMsgVpnBridgeTlsTrustedCommonNames", "parameters": [ { "description": "The name of the Message VPN.", @@ -47187,13 +43863,18 @@ "type": "string" }, { - "$ref": "#/parameters/countQuery" - }, - { - "$ref": "#/parameters/cursorQuery" + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -47213,9 +43894,9 @@ ], "responses": { "200": { - "description": "The list of Client Profile objects' attributes, and the request metadata.", + "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientProfilesResponse" + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNamesResponse" } }, "default": { @@ -47230,17 +43911,18 @@ "basicAuth": [] } ], - "summary": "Get a list of Client Profile objects.", + "summary": "Get a list of Trusted Common Name objects.", "tags": [ "all", "msgVpn", - "clientProfile" + "bridge" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||||x\napiQueueManagementCopyFromOnCreateName|||||x\napiTopicEndpointManagementCopyFromOnCreateName|||||x\nclientProfileName|x|x|x||\nmsgVpnName|x|||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnClientProfile", + "deprecated": true, + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x|x\nbridgeVirtualRouter|x|||x|x\nmsgVpnName|x|||x|x\ntlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "createMsgVpnBridgeTlsTrustedCommonName", "parameters": [ { "description": "The name of the Message VPN.", @@ -47250,12 +43932,26 @@ "type": "string" }, { - "description": "The Client Profile object's attributes.", + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Trusted Common Name object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnClientProfile" + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" } }, { @@ -47273,9 +43969,9 @@ ], "responses": { "200": { - "description": "The Client Profile object's attributes after being created, and the request metadata.", + "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientProfileResponse" + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" } }, "default": { @@ -47290,19 +43986,20 @@ "basicAuth": [] } ], - "summary": "Create a Client Profile object.", + "summary": "Create a Trusted Common Name object.", "tags": [ "all", "msgVpn", - "clientProfile" + "bridge" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}": { + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { "delete": { - "description": "Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnClientProfile", + "deprecated": true, + "description": "Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "deleteMsgVpnBridgeTlsTrustedCommonName", "parameters": [ { "description": "The name of the Message VPN.", @@ -47312,9 +44009,23 @@ "type": "string" }, { - "description": "The name of the Client Profile.", + "description": "The name of the Bridge.", "in": "path", - "name": "clientProfileName", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", "required": true, "type": "string" }, @@ -47344,75 +44055,18 @@ "basicAuth": [] } ], - "summary": "Delete a Client Profile object.", + "summary": "Delete a Trusted Common Name object.", "tags": [ "all", "msgVpn", - "clientProfile" + "bridge" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a Client Profile object.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallowCutThroughForwardingEnabled||x\napiQueueManagementCopyFromOnCreateName||x\napiTopicEndpointManagementCopyFromOnCreateName||x\nclientProfileName|x|\nmsgVpnName|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnClientProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Profile.", - "in": "path", - "name": "clientProfileName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Profile object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Client Profile object.", - "tags": [ - "all", - "msgVpn", - "clientProfile" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Client Profile object. Any attribute missing from the request will be left unchanged.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled||||x\napiQueueManagementCopyFromOnCreateName||||x\napiTopicEndpointManagementCopyFromOnCreateName||||x\nclientProfileName|x|x||\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "updateMsgVpnClientProfile", + "deprecated": true, + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nbridgeName|x|x\nbridgeVirtualRouter|x|x\nmsgVpnName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getMsgVpnBridgeTlsTrustedCommonName", "parameters": [ { "description": "The name of the Message VPN.", @@ -47422,88 +44076,26 @@ "type": "string" }, { - "description": "The name of the Client Profile.", + "description": "The name of the Bridge.", "in": "path", - "name": "clientProfileName", + "name": "bridgeName", "required": true, "type": "string" }, { - "description": "The Client Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnClientProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Profile object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Client Profile object.", - "tags": [ - "all", - "msgVpn", - "clientProfile" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled||||x\napiQueueManagementCopyFromOnCreateName||||x\napiTopicEndpointManagementCopyFromOnCreateName||||x\nclientProfileName|x|x||\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "replaceMsgVpnClientProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The virtual router of the Bridge.", "in": "path", - "name": "msgVpnName", + "name": "bridgeVirtualRouter", "required": true, "type": "string" }, { - "description": "The name of the Client Profile.", + "description": "The expected trusted common name of the remote certificate.", "in": "path", - "name": "clientProfileName", + "name": "tlsTrustedCommonName", "required": true, "type": "string" }, - { - "description": "The Client Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnClientProfile" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -47519,9 +44111,9 @@ ], "responses": { "200": { - "description": "The Client Profile object's attributes after being replaced, and the request metadata.", + "description": "The Trusted Common Name object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientProfileResponse" + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" } }, "default": { @@ -47536,19 +44128,19 @@ "basicAuth": [] } ], - "summary": "Replace a Client Profile object.", + "summary": "Get a Trusted Common Name object.", "tags": [ "all", "msgVpn", - "clientProfile" + "bridge" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/clientUsernames": { + "/msgVpns/{msgVpnName}/certMatchingRules": { "get": { - "description": "Get a list of Client Username objects.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientUsername|x||\nmsgVpnName|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnClientUsernames", + "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRules", "parameters": [ { "description": "The name of the Message VPN.", @@ -47584,9 +44176,9 @@ ], "responses": { "200": { - "description": "The list of Client Username objects' attributes, and the request metadata.", + "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernamesResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRulesResponse" } }, "default": { @@ -47601,17 +44193,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Client Username objects.", + "summary": "Get a list of Certificate Matching Rule objects.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { - "description": "Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientUsername|x|x|x|||\nmsgVpnName|x|||x||\npassword|||||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "createMsgVpnClientUsername", + "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nruleName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "createMsgVpnCertMatchingRule", "parameters": [ { "description": "The name of the Message VPN.", @@ -47621,12 +44213,12 @@ "type": "string" }, { - "description": "The Client Username object's attributes.", + "description": "The Certificate Matching Rule object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnClientUsername" + "$ref": "#/definitions/MsgVpnCertMatchingRule" } }, { @@ -47644,9 +44236,9 @@ ], "responses": { "200": { - "description": "The Client Username object's attributes after being created, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" } }, "default": { @@ -47661,19 +44253,19 @@ "basicAuth": [] } ], - "summary": "Create a Client Username object.", + "summary": "Create a Certificate Matching Rule object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}": { + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}": { "delete": { - "description": "Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "deleteMsgVpnClientUsername", + "description": "Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "deleteMsgVpnCertMatchingRule", "parameters": [ { "description": "The name of the Message VPN.", @@ -47683,9 +44275,9 @@ "type": "string" }, { - "description": "The name of the Client Username.", + "description": "The name of the rule.", "in": "path", - "name": "clientUsername", + "name": "ruleName", "required": true, "type": "string" }, @@ -47715,17 +44307,17 @@ "basicAuth": [] } ], - "summary": "Delete a Client Username object.", + "summary": "Delete a Certificate Matching Rule object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { - "description": "Get a Client Username object.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientUsername|x||\nmsgVpnName|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "getMsgVpnClientUsername", + "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRule", "parameters": [ { "description": "The name of the Message VPN.", @@ -47735,9 +44327,9 @@ "type": "string" }, { - "description": "The name of the Client Username.", + "description": "The name of the rule.", "in": "path", - "name": "clientUsername", + "name": "ruleName", "required": true, "type": "string" }, @@ -47756,9 +44348,9 @@ ], "responses": { "200": { - "description": "The Client Username object's attributes, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" } }, "default": { @@ -47773,17 +44365,17 @@ "basicAuth": [] } ], - "summary": "Get a Client Username object.", + "summary": "Get a Certificate Matching Rule object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Client Username object. Any attribute missing from the request will be left unchanged.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x|\nclientProfileName|||||x|\nclientUsername|x|x||||\nmsgVpnName|x||x|||\npassword||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "updateMsgVpnClientUsername", + "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "updateMsgVpnCertMatchingRule", "parameters": [ { "description": "The name of the Message VPN.", @@ -47793,19 +44385,19 @@ "type": "string" }, { - "description": "The name of the Client Username.", + "description": "The name of the rule.", "in": "path", - "name": "clientUsername", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Client Username object's attributes.", + "description": "The Certificate Matching Rule object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnClientUsername" + "$ref": "#/definitions/MsgVpnCertMatchingRule" } }, { @@ -47823,9 +44415,9 @@ ], "responses": { "200": { - "description": "The Client Username object's attributes after being updated, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" } }, "default": { @@ -47840,17 +44432,17 @@ "basicAuth": [] } ], - "summary": "Update a Client Username object.", + "summary": "Update a Certificate Matching Rule object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x|\nclientProfileName|||||x|\nclientUsername|x|x||||\nmsgVpnName|x||x|||\npassword||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", - "operationId": "replaceMsgVpnClientUsername", + "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "replaceMsgVpnCertMatchingRule", "parameters": [ { "description": "The name of the Message VPN.", @@ -47860,19 +44452,19 @@ "type": "string" }, { - "description": "The name of the Client Username.", + "description": "The name of the rule.", "in": "path", - "name": "clientUsername", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Client Username object's attributes.", + "description": "The Certificate Matching Rule object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnClientUsername" + "$ref": "#/definitions/MsgVpnCertMatchingRule" } }, { @@ -47890,9 +44482,9 @@ ], "responses": { "200": { - "description": "The Client Username object's attributes after being replaced, and the request metadata.", + "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" } }, "default": { @@ -47907,19 +44499,19 @@ "basicAuth": [] } ], - "summary": "Replace a Client Username object.", + "summary": "Replace a Certificate Matching Rule object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes": { + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters": { "get": { - "description": "Get a list of Client Username Attribute objects.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\nclientUsername|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", - "operationId": "getMsgVpnClientUsernameAttributes", + "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilterName|x\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "operationId": "getMsgVpnCertMatchingRuleAttributeFilters", "parameters": [ { "description": "The name of the Message VPN.", @@ -47929,9 +44521,9 @@ "type": "string" }, { - "description": "The name of the Client Username.", + "description": "The name of the rule.", "in": "path", - "name": "clientUsername", + "name": "ruleName", "required": true, "type": "string" }, @@ -47962,9 +44554,9 @@ ], "responses": { "200": { - "description": "The list of Client Username Attribute objects' attributes, and the request metadata.", + "description": "The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributesResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFiltersResponse" } }, "default": { @@ -47979,17 +44571,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Client Username Attribute objects.", + "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], "x-supportedInSempDirect": true }, "post": { - "description": "Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattributeName|x|x|x|\nattributeValue|x|x|x|\nclientUsername|x|||x\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "createMsgVpnClientUsernameAttribute", + "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nfilterName|x|x|x|\nmsgVpnName|x|||x\nruleName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Message VPN.", @@ -47999,19 +44591,19 @@ "type": "string" }, { - "description": "The name of the Client Username.", + "description": "The name of the rule.", "in": "path", - "name": "clientUsername", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Client Username Attribute object's attributes.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttribute" + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" } }, { @@ -48029,9 +44621,9 @@ ], "responses": { "200": { - "description": "The Client Username Attribute object's attributes after being created, and the request metadata.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" } }, "default": { @@ -48046,19 +44638,19 @@ "basicAuth": [] } ], - "summary": "Create a Client Username Attribute object.", + "summary": "Create a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}": { + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { "delete": { - "description": "Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "deleteMsgVpnClientUsernameAttribute", + "description": "Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Message VPN.", @@ -48068,23 +44660,16 @@ "type": "string" }, { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "required": true, - "type": "string" - }, - { - "description": "The name of the Attribute.", + "description": "The name of the rule.", "in": "path", - "name": "attributeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The value of the Attribute.", + "description": "The name of the filter.", "in": "path", - "name": "attributeValue", + "name": "filterName", "required": true, "type": "string" }, @@ -48114,17 +44699,17 @@ "basicAuth": [] } ], - "summary": "Delete a Client Username Attribute object.", + "summary": "Delete a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], "x-supportedInSempDirect": true }, "get": { - "description": "Get a Client Username Attribute object.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\nclientUsername|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", - "operationId": "getMsgVpnClientUsernameAttribute", + "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilterName|x\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Message VPN.", @@ -48134,23 +44719,16 @@ "type": "string" }, { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "required": true, - "type": "string" - }, - { - "description": "The name of the Attribute.", + "description": "The name of the rule.", "in": "path", - "name": "attributeName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The value of the Attribute.", + "description": "The name of the filter.", "in": "path", - "name": "attributeValue", + "name": "filterName", "required": true, "type": "string" }, @@ -48169,9 +44747,9 @@ ], "responses": { "200": { - "description": "The Client Username Attribute object's attributes, and the request metadata.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" } }, "default": { @@ -48186,19 +44764,17 @@ "basicAuth": [] } ], - "summary": "Get a Client Username Attribute object.", + "summary": "Get a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "msgVpn", - "clientUsername" + "certMatchingRule" ], "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/distributedCaches": { - "get": { - "description": "Get a list of Distributed Cache objects.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCaches", + }, + "patch": { + "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nfilterName|x|x|\nmsgVpnName|x||x\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "updateMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Message VPN.", @@ -48208,20 +44784,31 @@ "type": "string" }, { - "$ref": "#/parameters/countQuery" + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/cursorQuery" + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + } }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -48234,9 +44821,9 @@ ], "responses": { "200": { - "description": "The list of Distributed Cache objects' attributes, and the request metadata.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCachesResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" } }, "default": { @@ -48251,17 +44838,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Distributed Cache objects.", + "summary": "Update a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "msgVpn", - "distributedCache" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "post": { - "description": "Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|x|x|\ncacheVirtualRouter||x||\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createMsgVpnDistributedCache", + "put": { + "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nfilterName|x|x|\nmsgVpnName|x||x\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "replaceMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { "description": "The name of the Message VPN.", @@ -48271,12 +44858,26 @@ "type": "string" }, { - "description": "The Distributed Cache object's attributes.", + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCache" + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" } }, { @@ -48294,9 +44895,9 @@ ], "responses": { "200": { - "description": "The Distributed Cache object's attributes after being created, and the request metadata.", + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" } }, "default": { @@ -48311,19 +44912,19 @@ "basicAuth": [] } ], - "summary": "Create a Distributed Cache object.", + "summary": "Replace a Certificate Matching Rule Attribute Filter object.", "tags": [ "all", "msgVpn", - "distributedCache" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}": { - "delete": { - "description": "Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteMsgVpnDistributedCache", + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions": { + "get": { + "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRuleConditions", "parameters": [ { "description": "The name of the Message VPN.", @@ -48333,12 +44934,30 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", + "description": "The name of the rule.", "in": "path", - "name": "cacheName", + "name": "ruleName", "required": true, "type": "string" }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, { "$ref": "#/parameters/solSessionHeader" } @@ -48348,9 +44967,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionsResponse" } }, "default": { @@ -48365,17 +44984,17 @@ "basicAuth": [] } ], - "summary": "Delete a Distributed Cache object.", + "summary": "Get a list of Certificate Matching Rule Condition objects.", "tags": [ "all", "msgVpn", - "distributedCache" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "get": { - "description": "Get a Distributed Cache object.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCache", + "post": { + "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattribute||x||\nexpression||x||\nmsgVpnName|x|||x\nruleName|x|||x\nsource|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "createMsgVpnCertMatchingRuleCondition", "parameters": [ { "description": "The name of the Message VPN.", @@ -48385,12 +45004,21 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", + "description": "The name of the rule.", "in": "path", - "name": "cacheName", + "name": "ruleName", "required": true, "type": "string" }, + { + "description": "The Certificate Matching Rule Condition object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleCondition" + } + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -48406,9 +45034,9 @@ ], "responses": { "200": { - "description": "The Distributed Cache object's attributes, and the request metadata.", + "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" } }, "default": { @@ -48423,17 +45051,19 @@ "basicAuth": [] } ], - "summary": "Get a Distributed Cache object.", + "summary": "Create a Certificate Matching Rule Condition object.", "tags": [ "all", "msgVpn", - "distributedCache" + "certMatchingRule" ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Distributed Cache object. Any attribute missing from the request will be left unchanged.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\ncacheVirtualRouter||x|\nmsgVpnName|x||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "updateMsgVpnDistributedCache", + "x-supportedInSempDirect": true + } + }, + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}": { + "delete": { + "description": "Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "deleteMsgVpnCertMatchingRuleCondition", "parameters": [ { "description": "The name of the Message VPN.", @@ -48443,26 +45073,18 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", + "description": "The name of the rule.", "in": "path", - "name": "cacheName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Distributed Cache object's attributes.", - "in": "body", - "name": "body", + "description": "Certificate field to be compared with the Attribute.", + "in": "path", + "name": "source", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCache" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" + "type": "string" }, { "$ref": "#/parameters/solSessionHeader" @@ -48473,9 +45095,9 @@ ], "responses": { "200": { - "description": "The Distributed Cache object's attributes after being updated, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -48490,17 +45112,17 @@ "basicAuth": [] } ], - "summary": "Update a Distributed Cache object.", + "summary": "Delete a Certificate Matching Rule Condition object.", "tags": [ "all", "msgVpn", - "distributedCache" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, - "put": { - "description": "Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\ncacheVirtualRouter||x|\nmsgVpnName|x||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "replaceMsgVpnDistributedCache", + "get": { + "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRuleCondition", "parameters": [ { "description": "The name of the Message VPN.", @@ -48510,20 +45132,18 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", + "description": "The name of the rule.", "in": "path", - "name": "cacheName", + "name": "ruleName", "required": true, "type": "string" }, { - "description": "The Distributed Cache object's attributes.", - "in": "body", - "name": "body", + "description": "Certificate field to be compared with the Attribute.", + "in": "path", + "name": "source", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCache" - } + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -48540,9 +45160,9 @@ ], "responses": { "200": { - "description": "The Distributed Cache object's attributes after being replaced, and the request metadata.", + "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" } }, "default": { @@ -48557,19 +45177,19 @@ "basicAuth": [] } ], - "summary": "Replace a Distributed Cache object.", + "summary": "Get a Certificate Matching Rule Condition object.", "tags": [ "all", "msgVpn", - "distributedCache" + "certMatchingRule" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters": { + "/msgVpns/{msgVpnName}/clientProfiles": { "get": { - "description": "Get a list of Cache Cluster objects.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusters", + "description": "Get a list of Client Profile objects.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallowCutThroughForwardingEnabled||x\napiQueueManagementCopyFromOnCreateName||x\napiTopicEndpointManagementCopyFromOnCreateName||x\nclientProfileName|x|\nmsgVpnName|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientProfiles", "parameters": [ { "description": "The name of the Message VPN.", @@ -48578,13 +45198,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -48612,9 +45225,9 @@ ], "responses": { "200": { - "description": "The list of Cache Cluster objects' attributes, and the request metadata.", + "description": "The list of Client Profile objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClustersResponse" + "$ref": "#/definitions/MsgVpnClientProfilesResponse" } }, "default": { @@ -48629,17 +45242,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Cache Cluster objects.", + "summary": "Get a list of Client Profile objects.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientProfile" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createMsgVpnDistributedCacheCluster", + "description": "Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||||x\napiQueueManagementCopyFromOnCreateName|||||x\napiTopicEndpointManagementCopyFromOnCreateName|||||x\nclientProfileName|x|x|x||\nmsgVpnName|x|||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnClientProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -48649,19 +45262,12 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The Cache Cluster object's attributes.", + "description": "The Client Profile object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + "$ref": "#/definitions/MsgVpnClientProfile" } }, { @@ -48679,9 +45285,9 @@ ], "responses": { "200": { - "description": "The Cache Cluster object's attributes after being created, and the request metadata.", + "description": "The Client Profile object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + "$ref": "#/definitions/MsgVpnClientProfileResponse" } }, "default": { @@ -48696,19 +45302,19 @@ "basicAuth": [] } ], - "summary": "Create a Cache Cluster object.", + "summary": "Create a Client Profile object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientProfile" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}": { + "/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}": { "delete": { - "description": "Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteMsgVpnDistributedCacheCluster", + "description": "Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnClientProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -48718,16 +45324,9 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", + "description": "The name of the Client Profile.", "in": "path", - "name": "clusterName", + "name": "clientProfileName", "required": true, "type": "string" }, @@ -48757,17 +45356,17 @@ "basicAuth": [] } ], - "summary": "Delete a Cache Cluster object.", + "summary": "Delete a Client Profile object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientProfile" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a Cache Cluster object.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheCluster", + "description": "Get a Client Profile object.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallowCutThroughForwardingEnabled||x\napiQueueManagementCopyFromOnCreateName||x\napiTopicEndpointManagementCopyFromOnCreateName||x\nclientProfileName|x|\nmsgVpnName|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -48777,16 +45376,9 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", + "description": "The name of the Client Profile.", "in": "path", - "name": "clusterName", + "name": "clientProfileName", "required": true, "type": "string" }, @@ -48805,9 +45397,9 @@ ], "responses": { "200": { - "description": "The Cache Cluster object's attributes, and the request metadata.", + "description": "The Client Profile object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + "$ref": "#/definitions/MsgVpnClientProfileResponse" } }, "default": { @@ -48822,17 +45414,17 @@ "basicAuth": [] } ], - "summary": "Get a Cache Cluster object.", + "summary": "Get a Client Profile object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientProfile" ], "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Cache Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ncacheName|x||x|\nclusterName|x|x||\ndeliverToOneOverrideEnabled||||x\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "updateMsgVpnDistributedCacheCluster", + "description": "Update a Client Profile object. Any attribute missing from the request will be left unchanged.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled||||x\napiQueueManagementCopyFromOnCreateName||||x\napiTopicEndpointManagementCopyFromOnCreateName||||x\nclientProfileName|x|x||\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnClientProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -48842,26 +45434,19 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", + "description": "The name of the Client Profile.", "in": "path", - "name": "clusterName", + "name": "clientProfileName", "required": true, "type": "string" }, { - "description": "The Cache Cluster object's attributes.", + "description": "The Client Profile object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + "$ref": "#/definitions/MsgVpnClientProfile" } }, { @@ -48879,9 +45464,9 @@ ], "responses": { "200": { - "description": "The Cache Cluster object's attributes after being updated, and the request metadata.", + "description": "The Client Profile object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + "$ref": "#/definitions/MsgVpnClientProfileResponse" } }, "default": { @@ -48896,17 +45481,17 @@ "basicAuth": [] } ], - "summary": "Update a Cache Cluster object.", + "summary": "Update a Client Profile object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientProfile" ], "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ncacheName|x||x|\nclusterName|x|x||\ndeliverToOneOverrideEnabled||||x\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "replaceMsgVpnDistributedCacheCluster", + "description": "Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled||||x\napiQueueManagementCopyFromOnCreateName||||x\napiTopicEndpointManagementCopyFromOnCreateName||||x\nclientProfileName|x|x||\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnClientProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -48916,26 +45501,19 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", + "description": "The name of the Client Profile.", "in": "path", - "name": "clusterName", + "name": "clientProfileName", "required": true, "type": "string" }, { - "description": "The Cache Cluster object's attributes.", + "description": "The Client Profile object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + "$ref": "#/definitions/MsgVpnClientProfile" } }, { @@ -48953,9 +45531,9 @@ ], "responses": { "200": { - "description": "The Cache Cluster object's attributes after being replaced, and the request metadata.", + "description": "The Client Profile object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + "$ref": "#/definitions/MsgVpnClientProfileResponse" } }, "default": { @@ -48970,19 +45548,19 @@ "basicAuth": [] } ], - "summary": "Replace a Cache Cluster object.", + "summary": "Replace a Client Profile object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientProfile" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters": { + "/msgVpns/{msgVpnName}/clientUsernames": { "get": { - "description": "Get a list of Home Cache Cluster objects.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters", + "description": "Get a list of Client Username objects.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientUsername|x||\nmsgVpnName|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientUsernames", "parameters": [ { "description": "The name of the Message VPN.", @@ -48991,20 +45569,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -49032,9 +45596,9 @@ ], "responses": { "200": { - "description": "The list of Home Cache Cluster objects' attributes, and the request metadata.", + "description": "The list of Client Username objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse" + "$ref": "#/definitions/MsgVpnClientUsernamesResponse" } }, "default": { @@ -49049,17 +45613,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Home Cache Cluster objects.", + "summary": "Get a list of Client Username objects.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nhomeClusterName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", + "description": "Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientUsername|x|x|x|||\nmsgVpnName|x|||x||\npassword|||||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnClientUsername", "parameters": [ { "description": "The name of the Message VPN.", @@ -49069,26 +45633,12 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The Home Cache Cluster object's attributes.", + "description": "The Client Username object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" + "$ref": "#/definitions/MsgVpnClientUsername" } }, { @@ -49106,9 +45656,9 @@ ], "responses": { "200": { - "description": "The Home Cache Cluster object's attributes after being created, and the request metadata.", + "description": "The Client Username object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" + "$ref": "#/definitions/MsgVpnClientUsernameResponse" } }, "default": { @@ -49123,19 +45673,19 @@ "basicAuth": [] } ], - "summary": "Create a Home Cache Cluster object.", + "summary": "Create a Client Username object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}": { + "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}": { "delete": { - "description": "Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", + "description": "Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnClientUsername", "parameters": [ { "description": "The name of the Message VPN.", @@ -49145,23 +45695,9 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the remote Home Cache Cluster.", + "description": "The name of the Client Username.", "in": "path", - "name": "homeClusterName", + "name": "clientUsername", "required": true, "type": "string" }, @@ -49191,17 +45727,17 @@ "basicAuth": [] } ], - "summary": "Delete a Home Cache Cluster object.", + "summary": "Delete a Client Username object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a Home Cache Cluster object.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", + "description": "Get a Client Username object.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientUsername|x||\nmsgVpnName|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientUsername", "parameters": [ { "description": "The name of the Message VPN.", @@ -49211,26 +45747,79 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", + "description": "The name of the Client Username.", "in": "path", - "name": "cacheName", + "name": "clientUsername", "required": true, "type": "string" }, { - "description": "The name of the Cache Cluster.", + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Client Username object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ], + "x-supportedInSempDirect": false + }, + "patch": { + "description": "Update a Client Username object. Any attribute missing from the request will be left unchanged.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x|\nclientProfileName|||||x|\nclientUsername|x|x||||\nmsgVpnName|x||x|||\npassword||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnClientUsername", + "parameters": [ + { + "description": "The name of the Message VPN.", "in": "path", - "name": "clusterName", + "name": "msgVpnName", "required": true, "type": "string" }, { - "description": "The name of the remote Home Cache Cluster.", + "description": "The name of the Client Username.", "in": "path", - "name": "homeClusterName", + "name": "clientUsername", "required": true, "type": "string" }, + { + "description": "The Client Username object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientUsername" + } + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -49246,9 +45835,9 @@ ], "responses": { "200": { - "description": "The Home Cache Cluster object's attributes, and the request metadata.", + "description": "The Client Username object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" + "$ref": "#/definitions/MsgVpnClientUsernameResponse" } }, "default": { @@ -49263,19 +45852,17 @@ "basicAuth": [] } ], - "summary": "Get a Home Cache Cluster object.", + "summary": "Update a Client Username object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes": { - "get": { - "description": "Get a list of Topic Prefix objects.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\ntopicPrefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes", + }, + "put": { + "description": "Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x|\nclientProfileName|||||x|\nclientUsername|x|x||||\nmsgVpnName|x||x|||\npassword||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnClientUsername", "parameters": [ { "description": "The name of the Message VPN.", @@ -49285,23 +45872,78 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", + "description": "The name of the Client Username.", "in": "path", - "name": "cacheName", + "name": "clientUsername", "required": true, "type": "string" }, { - "description": "The name of the Cache Cluster.", + "description": "The Client Username object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientUsername" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Client Username object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ], + "x-supportedInSempDirect": false + } + }, + "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes": { + "get": { + "description": "Get a list of Client Username Attribute objects.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\nclientUsername|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnClientUsernameAttributes", + "parameters": [ + { + "description": "The name of the Message VPN.", "in": "path", - "name": "clusterName", + "name": "msgVpnName", "required": true, "type": "string" }, { - "description": "The name of the remote Home Cache Cluster.", + "description": "The name of the Client Username.", "in": "path", - "name": "homeClusterName", + "name": "clientUsername", "required": true, "type": "string" }, @@ -49332,9 +45974,9 @@ ], "responses": { "200": { - "description": "The list of Topic Prefix objects' attributes, and the request metadata.", + "description": "The list of Client Username Attribute objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse" + "$ref": "#/definitions/MsgVpnClientUsernameAttributesResponse" } }, "default": { @@ -49349,17 +45991,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Topic Prefix objects.", + "summary": "Get a list of Client Username Attribute objects.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { - "description": "Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nhomeClusterName|x|||x\nmsgVpnName|x|||x\ntopicPrefix|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", + "description": "Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattributeName|x|x|x|\nattributeValue|x|x|x|\nclientUsername|x|||x\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "createMsgVpnClientUsernameAttribute", "parameters": [ { "description": "The name of the Message VPN.", @@ -49369,33 +46011,19 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the remote Home Cache Cluster.", + "description": "The name of the Client Username.", "in": "path", - "name": "homeClusterName", + "name": "clientUsername", "required": true, "type": "string" }, { - "description": "The Topic Prefix object's attributes.", + "description": "The Client Username Attribute object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix" + "$ref": "#/definitions/MsgVpnClientUsernameAttribute" } }, { @@ -49413,9 +46041,9 @@ ], "responses": { "200": { - "description": "The Topic Prefix object's attributes after being created, and the request metadata.", + "description": "The Client Username Attribute object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" + "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" } }, "default": { @@ -49430,19 +46058,19 @@ "basicAuth": [] } ], - "summary": "Create a Topic Prefix object.", + "summary": "Create a Client Username Attribute object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}": { + "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}": { "delete": { - "description": "Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", + "description": "Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "deleteMsgVpnClientUsernameAttribute", "parameters": [ { "description": "The name of the Message VPN.", @@ -49452,30 +46080,23 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", + "description": "The name of the Client Username.", "in": "path", - "name": "clusterName", + "name": "clientUsername", "required": true, "type": "string" }, { - "description": "The name of the remote Home Cache Cluster.", + "description": "The name of the Attribute.", "in": "path", - "name": "homeClusterName", + "name": "attributeName", "required": true, "type": "string" }, { - "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "description": "The value of the Attribute.", "in": "path", - "name": "topicPrefix", + "name": "attributeValue", "required": true, "type": "string" }, @@ -49505,17 +46126,17 @@ "basicAuth": [] } ], - "summary": "Delete a Topic Prefix object.", + "summary": "Delete a Client Username Attribute object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { - "description": "Get a Topic Prefix object.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\ntopicPrefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", + "description": "Get a Client Username Attribute object.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\nclientUsername|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnClientUsernameAttribute", "parameters": [ { "description": "The name of the Message VPN.", @@ -49525,30 +46146,23 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", + "description": "The name of the Client Username.", "in": "path", - "name": "clusterName", + "name": "clientUsername", "required": true, "type": "string" }, { - "description": "The name of the remote Home Cache Cluster.", + "description": "The name of the Attribute.", "in": "path", - "name": "homeClusterName", + "name": "attributeName", "required": true, "type": "string" }, { - "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "description": "The value of the Attribute.", "in": "path", - "name": "topicPrefix", + "name": "attributeValue", "required": true, "type": "string" }, @@ -49567,9 +46181,9 @@ ], "responses": { "200": { - "description": "The Topic Prefix object's attributes, and the request metadata.", + "description": "The Client Username Attribute object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" + "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" } }, "default": { @@ -49584,19 +46198,19 @@ "basicAuth": [] } ], - "summary": "Get a Topic Prefix object.", + "summary": "Get a Client Username Attribute object.", "tags": [ "all", "msgVpn", - "distributedCache" + "clientUsername" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances": { + "/msgVpns/{msgVpnName}/distributedCaches": { "get": { - "description": "Get a list of Cache Instance objects.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterInstances", + "description": "Get a list of Distributed Cache objects.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCaches", "parameters": [ { "description": "The name of the Message VPN.", @@ -49605,20 +46219,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -49646,9 +46246,9 @@ ], "responses": { "200": { - "description": "The list of Cache Instance objects' attributes, and the request metadata.", + "description": "The list of Distributed Cache objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstancesResponse" + "$ref": "#/definitions/MsgVpnDistributedCachesResponse" } }, "default": { @@ -49663,7 +46263,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Cache Instance objects.", + "summary": "Get a list of Distributed Cache objects.", "tags": [ "all", "msgVpn", @@ -49672,8 +46272,8 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\ninstanceName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createMsgVpnDistributedCacheClusterInstance", + "description": "Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|x|x|\ncacheVirtualRouter||x||\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCache", "parameters": [ { "description": "The name of the Message VPN.", @@ -49683,26 +46283,12 @@ "type": "string" }, { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The Cache Instance object's attributes.", + "description": "The Distributed Cache object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + "$ref": "#/definitions/MsgVpnDistributedCache" } }, { @@ -49720,9 +46306,9 @@ ], "responses": { "200": { - "description": "The Cache Instance object's attributes after being created, and the request metadata.", + "description": "The Distributed Cache object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" } }, "default": { @@ -49737,7 +46323,7 @@ "basicAuth": [] } ], - "summary": "Create a Cache Instance object.", + "summary": "Create a Distributed Cache object.", "tags": [ "all", "msgVpn", @@ -49746,10 +46332,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}": { + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}": { "delete": { - "description": "Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteMsgVpnDistributedCacheClusterInstance", + "description": "Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCache", "parameters": [ { "description": "The name of the Message VPN.", @@ -49765,20 +46351,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Instance.", - "in": "path", - "name": "instanceName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -49805,7 +46377,7 @@ "basicAuth": [] } ], - "summary": "Delete a Cache Instance object.", + "summary": "Delete a Distributed Cache object.", "tags": [ "all", "msgVpn", @@ -49814,8 +46386,8 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Cache Instance object.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterInstance", + "description": "Get a Distributed Cache object.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCache", "parameters": [ { "description": "The name of the Message VPN.", @@ -49831,20 +46403,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Instance.", - "in": "path", - "name": "instanceName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -49860,9 +46418,9 @@ ], "responses": { "200": { - "description": "The Cache Instance object's attributes, and the request metadata.", + "description": "The Distributed Cache object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" } }, "default": { @@ -49877,7 +46435,7 @@ "basicAuth": [] } ], - "summary": "Get a Cache Instance object.", + "summary": "Get a Distributed Cache object.", "tags": [ "all", "msgVpn", @@ -49886,8 +46444,8 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Cache Instance object. Any attribute missing from the request will be left unchanged.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x||x\nclusterName|x||x\ninstanceName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "updateMsgVpnDistributedCacheClusterInstance", + "description": "Update a Distributed Cache object. Any attribute missing from the request will be left unchanged.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\ncacheVirtualRouter||x|\nmsgVpnName|x||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDistributedCache", "parameters": [ { "description": "The name of the Message VPN.", @@ -49904,26 +46462,12 @@ "type": "string" }, { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Instance.", - "in": "path", - "name": "instanceName", - "required": true, - "type": "string" - }, - { - "description": "The Cache Instance object's attributes.", + "description": "The Distributed Cache object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + "$ref": "#/definitions/MsgVpnDistributedCache" } }, { @@ -49941,9 +46485,9 @@ ], "responses": { "200": { - "description": "The Cache Instance object's attributes after being updated, and the request metadata.", + "description": "The Distributed Cache object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" } }, "default": { @@ -49958,7 +46502,7 @@ "basicAuth": [] } ], - "summary": "Update a Cache Instance object.", + "summary": "Update a Distributed Cache object.", "tags": [ "all", "msgVpn", @@ -49967,8 +46511,8 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x||x\nclusterName|x||x\ninstanceName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "replaceMsgVpnDistributedCacheClusterInstance", + "description": "Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\ncacheVirtualRouter||x|\nmsgVpnName|x||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDistributedCache", "parameters": [ { "description": "The name of the Message VPN.", @@ -49985,26 +46529,12 @@ "type": "string" }, { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Cache Instance.", - "in": "path", - "name": "instanceName", - "required": true, - "type": "string" - }, - { - "description": "The Cache Instance object's attributes.", + "description": "The Distributed Cache object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + "$ref": "#/definitions/MsgVpnDistributedCache" } }, { @@ -50022,9 +46552,9 @@ ], "responses": { "200": { - "description": "The Cache Instance object's attributes after being replaced, and the request metadata.", + "description": "The Distributed Cache object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" } }, "default": { @@ -50039,7 +46569,7 @@ "basicAuth": [] } ], - "summary": "Replace a Cache Instance object.", + "summary": "Replace a Distributed Cache object.", "tags": [ "all", "msgVpn", @@ -50048,10 +46578,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics": { + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters": { "get": { - "description": "Get a list of Topic objects.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterTopics", + "description": "Get a list of Cache Cluster objects.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusters", "parameters": [ { "description": "The name of the Message VPN.", @@ -50067,13 +46597,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -50101,9 +46624,9 @@ ], "responses": { "200": { - "description": "The list of Topic objects' attributes, and the request metadata.", + "description": "The list of Cache Cluster objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicsResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClustersResponse" } }, "default": { @@ -50118,7 +46641,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Topic objects.", + "summary": "Get a list of Cache Cluster objects.", "tags": [ "all", "msgVpn", @@ -50127,8 +46650,8 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nmsgVpnName|x|||x\ntopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createMsgVpnDistributedCacheClusterTopic", + "description": "Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50145,19 +46668,12 @@ "type": "string" }, { - "description": "The name of the Cache Cluster.", - "in": "path", - "name": "clusterName", - "required": true, - "type": "string" - }, - { - "description": "The Topic object's attributes.", + "description": "The Cache Cluster object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" } }, { @@ -50175,9 +46691,9 @@ ], "responses": { "200": { - "description": "The Topic object's attributes after being created, and the request metadata.", + "description": "The Cache Cluster object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" } }, "default": { @@ -50192,7 +46708,7 @@ "basicAuth": [] } ], - "summary": "Create a Topic object.", + "summary": "Create a Cache Cluster object.", "tags": [ "all", "msgVpn", @@ -50201,10 +46717,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}": { + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}": { "delete": { - "description": "Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteMsgVpnDistributedCacheClusterTopic", + "description": "Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50227,13 +46743,6 @@ "required": true, "type": "string" }, - { - "description": "The value of the Topic in the form a/b/c.", - "in": "path", - "name": "topic", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -50260,7 +46769,7 @@ "basicAuth": [] } ], - "summary": "Delete a Topic object.", + "summary": "Delete a Cache Cluster object.", "tags": [ "all", "msgVpn", @@ -50269,8 +46778,8 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic object.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDistributedCacheClusterTopic", + "description": "Get a Cache Cluster object.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50293,13 +46802,6 @@ "required": true, "type": "string" }, - { - "description": "The value of the Topic in the form a/b/c.", - "in": "path", - "name": "topic", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -50315,9 +46817,9 @@ ], "responses": { "200": { - "description": "The Topic object's attributes, and the request metadata.", + "description": "The Cache Cluster object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" } }, "default": { @@ -50332,19 +46834,17 @@ "basicAuth": [] } ], - "summary": "Get a Topic object.", + "summary": "Get a Cache Cluster object.", "tags": [ "all", "msgVpn", "distributedCache" ], "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/dmrBridges": { - "get": { - "description": "Get a list of DMR Bridge objects.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDmrBridges", + }, + "patch": { + "description": "Update a Cache Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ncacheName|x||x|\nclusterName|x|x||\ndeliverToOneOverrideEnabled||||x\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDistributedCacheCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50354,20 +46854,31 @@ "type": "string" }, { - "$ref": "#/parameters/countQuery" + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/cursorQuery" + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The Cache Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + } }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -50380,9 +46891,9 @@ ], "responses": { "200": { - "description": "The list of DMR Bridge objects' attributes, and the request metadata.", + "description": "The Cache Cluster object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgesResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" } }, "default": { @@ -50397,17 +46908,17 @@ "basicAuth": [] } ], - "summary": "Get a list of DMR Bridge objects.", + "summary": "Update a Cache Cluster object.", "tags": [ "all", "msgVpn", - "dmrBridge" + "distributedCache" ], "x-supportedInSempDirect": false }, - "post": { - "description": "Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nremoteNodeName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "createMsgVpnDmrBridge", + "put": { + "description": "Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ncacheName|x||x|\nclusterName|x|x||\ndeliverToOneOverrideEnabled||||x\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDistributedCacheCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50417,12 +46928,26 @@ "type": "string" }, { - "description": "The DMR Bridge object's attributes.", + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Cluster object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDmrBridge" + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" } }, { @@ -50440,9 +46965,9 @@ ], "responses": { "200": { - "description": "The DMR Bridge object's attributes after being created, and the request metadata.", + "description": "The Cache Cluster object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" } }, "default": { @@ -50457,19 +46982,19 @@ "basicAuth": [] } ], - "summary": "Create a DMR Bridge object.", + "summary": "Replace a Cache Cluster object.", "tags": [ "all", "msgVpn", - "dmrBridge" + "distributedCache" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}": { - "delete": { - "description": "Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "deleteMsgVpnDmrBridge", + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters": { + "get": { + "description": "Get a list of Home Cache Cluster objects.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters", "parameters": [ { "description": "The name of the Message VPN.", @@ -50479,67 +47004,34 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the DMR Bridge.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "remoteNodeName", + "name": "cacheName", "required": true, "type": "string" }, { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete a DMR Bridge object.", - "tags": [ - "all", - "msgVpn", - "dmrBridge" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a DMR Bridge object.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "getMsgVpnDmrBridge", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The name of the Cache Cluster.", "in": "path", - "name": "msgVpnName", + "name": "clusterName", "required": true, "type": "string" }, { - "description": "The name of the node at the remote end of the DMR Bridge.", - "in": "path", - "name": "remoteNodeName", - "required": true, - "type": "string" + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" }, { "$ref": "#/parameters/opaquePasswordQuery" }, + { + "$ref": "#/parameters/whereQuery" + }, { "$ref": "#/parameters/selectQuery" }, @@ -50552,9 +47044,9 @@ ], "responses": { "200": { - "description": "The DMR Bridge object's attributes, and the request metadata.", + "description": "The list of Home Cache Cluster objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse" } }, "default": { @@ -50569,17 +47061,17 @@ "basicAuth": [] } ], - "summary": "Get a DMR Bridge object.", + "summary": "Get a list of Home Cache Cluster objects.", "tags": [ "all", "msgVpn", - "dmrBridge" + "distributedCache" ], "x-supportedInSempDirect": false }, - "patch": { - "description": "Update a DMR Bridge object. Any attribute missing from the request will be left unchanged.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nremoteNodeName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "updateMsgVpnDmrBridge", + "post": { + "description": "Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nhomeClusterName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50589,19 +47081,26 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the DMR Bridge.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "remoteNodeName", + "name": "cacheName", "required": true, "type": "string" }, { - "description": "The DMR Bridge object's attributes.", + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Home Cache Cluster object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnDmrBridge" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" } }, { @@ -50619,9 +47118,9 @@ ], "responses": { "200": { - "description": "The DMR Bridge object's attributes after being updated, and the request metadata.", + "description": "The Home Cache Cluster object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" } }, "default": { @@ -50636,17 +47135,19 @@ "basicAuth": [] } ], - "summary": "Update a DMR Bridge object.", + "summary": "Create a Home Cache Cluster object.", "tags": [ "all", "msgVpn", - "dmrBridge" + "distributedCache" ], "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nremoteNodeName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", - "operationId": "replaceMsgVpnDmrBridge", + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}": { + "delete": { + "description": "Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50656,26 +47157,25 @@ "type": "string" }, { - "description": "The name of the node at the remote end of the DMR Bridge.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "remoteNodeName", + "name": "cacheName", "required": true, "type": "string" }, { - "description": "The DMR Bridge object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridge" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" + "type": "string" }, { - "$ref": "#/parameters/selectQuery" + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" }, { "$ref": "#/parameters/solSessionHeader" @@ -50686,9 +47186,9 @@ ], "responses": { "200": { - "description": "The DMR Bridge object's attributes after being replaced, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -50703,19 +47203,17 @@ "basicAuth": [] } ], - "summary": "Replace a DMR Bridge object.", + "summary": "Delete a Home Cache Cluster object.", "tags": [ "all", "msgVpn", - "dmrBridge" + "distributedCache" ], "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/jndiConnectionFactories": { + }, "get": { - "description": "Get a list of JNDI Connection Factory objects.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnectionFactoryName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", - "operationId": "getMsgVpnJndiConnectionFactories", + "description": "Get a Home Cache Cluster object.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", "parameters": [ { "description": "The name of the Message VPN.", @@ -50725,20 +47223,29 @@ "type": "string" }, { - "$ref": "#/parameters/countQuery" + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/cursorQuery" + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/forceFullPageQuery" + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" }, - { - "$ref": "#/parameters/whereQuery" - }, { "$ref": "#/parameters/selectQuery" }, @@ -50751,9 +47258,9 @@ ], "responses": { "200": { - "description": "The list of JNDI Connection Factory objects' attributes, and the request metadata.", + "description": "The Home Cache Cluster object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoriesResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" } }, "default": { @@ -50768,17 +47275,19 @@ "basicAuth": [] } ], - "summary": "Get a list of JNDI Connection Factory objects.", + "summary": "Get a Home Cache Cluster object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "createMsgVpnJndiConnectionFactory", + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes": { + "get": { + "description": "Get a list of Topic Prefix objects.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\ntopicPrefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes", "parameters": [ { "description": "The name of the Message VPN.", @@ -50788,73 +47297,43 @@ "type": "string" }, { - "description": "The JNDI Connection Factory object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - } + "type": "string" }, { - "$ref": "#/parameters/opaquePasswordQuery" + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/selectQuery" + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Connection Factory object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" - } + "$ref": "#/parameters/countQuery" }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ { - "basicAuth": [] - } - ], - "summary": "Create a JNDI Connection Factory object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}": { - "delete": { - "description": "Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "deleteMsgVpnJndiConnectionFactory", - "parameters": [ + "$ref": "#/parameters/cursorQuery" + }, { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" + "$ref": "#/parameters/forceFullPageQuery" }, { - "description": "The name of the JMS Connection Factory.", - "in": "path", - "name": "connectionFactoryName", - "required": true, - "type": "string" + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" }, { "$ref": "#/parameters/solSessionHeader" @@ -50865,9 +47344,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The list of Topic Prefix objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse" } }, "default": { @@ -50882,17 +47361,17 @@ "basicAuth": [] } ], - "summary": "Delete a JNDI Connection Factory object.", + "summary": "Get a list of Topic Prefix objects.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, - "get": { - "description": "Get a JNDI Connection Factory object.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnectionFactoryName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "getMsgVpnJndiConnectionFactory", + "post": { + "description": "Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nhomeClusterName|x|||x\nmsgVpnName|x|||x\ntopicPrefix|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", "parameters": [ { "description": "The name of the Message VPN.", @@ -50902,12 +47381,35 @@ "type": "string" }, { - "description": "The name of the JMS Connection Factory.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "connectionFactoryName", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", "required": true, "type": "string" }, + { + "description": "The Topic Prefix object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix" + } + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -50923,9 +47425,9 @@ ], "responses": { "200": { - "description": "The JNDI Connection Factory object's attributes, and the request metadata.", + "description": "The Topic Prefix object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" } }, "default": { @@ -50940,17 +47442,19 @@ "basicAuth": [] } ], - "summary": "Get a JNDI Connection Factory object.", + "summary": "Create a Topic Prefix object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nconnectionFactoryName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "updateMsgVpnJndiConnectionFactory", + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}": { + "delete": { + "description": "Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", "parameters": [ { "description": "The name of the Message VPN.", @@ -50960,26 +47464,32 @@ "type": "string" }, { - "description": "The name of the JMS Connection Factory.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "connectionFactoryName", + "name": "cacheName", "required": true, "type": "string" }, { - "description": "The JNDI Connection Factory object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - } + "type": "string" }, { - "$ref": "#/parameters/opaquePasswordQuery" + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/selectQuery" + "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "in": "path", + "name": "topicPrefix", + "required": true, + "type": "string" }, { "$ref": "#/parameters/solSessionHeader" @@ -50990,9 +47500,9 @@ ], "responses": { "200": { - "description": "The JNDI Connection Factory object's attributes after being updated, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -51007,17 +47517,17 @@ "basicAuth": [] } ], - "summary": "Update a JNDI Connection Factory object.", + "summary": "Delete a Topic Prefix object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, - "put": { - "description": "Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nconnectionFactoryName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "replaceMsgVpnJndiConnectionFactory", + "get": { + "description": "Get a Topic Prefix object.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\ntopicPrefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", "parameters": [ { "description": "The name of the Message VPN.", @@ -51027,20 +47537,32 @@ "type": "string" }, { - "description": "The name of the JMS Connection Factory.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "connectionFactoryName", + "name": "cacheName", "required": true, "type": "string" }, { - "description": "The JNDI Connection Factory object's attributes.", - "in": "body", - "name": "body", + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - } + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" + }, + { + "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "in": "path", + "name": "topicPrefix", + "required": true, + "type": "string" }, { "$ref": "#/parameters/opaquePasswordQuery" @@ -51057,9 +47579,9 @@ ], "responses": { "200": { - "description": "The JNDI Connection Factory object's attributes after being replaced, and the request metadata.", + "description": "The Topic Prefix object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" } }, "default": { @@ -51074,19 +47596,19 @@ "basicAuth": [] } ], - "summary": "Replace a JNDI Connection Factory object.", + "summary": "Get a Topic Prefix object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/jndiQueues": { + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances": { "get": { - "description": "Get a list of JNDI Queue objects.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", - "operationId": "getMsgVpnJndiQueues", + "description": "Get a list of Cache Instance objects.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterInstances", "parameters": [ { "description": "The name of the Message VPN.", @@ -51095,6 +47617,20 @@ "required": true, "type": "string" }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/countQuery" }, @@ -51122,9 +47658,9 @@ ], "responses": { "200": { - "description": "The list of JNDI Queue objects' attributes, and the request metadata.", + "description": "The list of Cache Instance objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiQueuesResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstancesResponse" } }, "default": { @@ -51139,17 +47675,17 @@ "basicAuth": [] } ], - "summary": "Get a list of JNDI Queue objects.", + "summary": "Get a list of Cache Instance objects.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "createMsgVpnJndiQueue", + "description": "Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\ninstanceName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterInstance", "parameters": [ { "description": "The name of the Message VPN.", @@ -51159,12 +47695,26 @@ "type": "string" }, { - "description": "The JNDI Queue object's attributes.", + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Instance object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnJndiQueue" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" } }, { @@ -51182,9 +47732,9 @@ ], "responses": { "200": { - "description": "The JNDI Queue object's attributes after being created, and the request metadata.", + "description": "The Cache Instance object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" } }, "default": { @@ -51199,19 +47749,19 @@ "basicAuth": [] } ], - "summary": "Create a JNDI Queue object.", + "summary": "Create a Cache Instance object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/jndiQueues/{queueName}": { + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}": { "delete": { - "description": "Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "deleteMsgVpnJndiQueue", + "description": "Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterInstance", "parameters": [ { "description": "The name of the Message VPN.", @@ -51221,9 +47771,23 @@ "type": "string" }, { - "description": "The JNDI name of the JMS Queue.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "queueName", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", "required": true, "type": "string" }, @@ -51253,17 +47817,17 @@ "basicAuth": [] } ], - "summary": "Delete a JNDI Queue object.", + "summary": "Delete a Cache Instance object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a JNDI Queue object.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "getMsgVpnJndiQueue", + "description": "Get a Cache Instance object.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterInstance", "parameters": [ { "description": "The name of the Message VPN.", @@ -51273,9 +47837,23 @@ "type": "string" }, { - "description": "The JNDI name of the JMS Queue.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "queueName", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", "required": true, "type": "string" }, @@ -51294,9 +47872,9 @@ ], "responses": { "200": { - "description": "The JNDI Queue object's attributes, and the request metadata.", + "description": "The Cache Instance object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" } }, "default": { @@ -51311,17 +47889,17 @@ "basicAuth": [] } ], - "summary": "Get a JNDI Queue object.", + "summary": "Get a Cache Instance object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, "patch": { - "description": "Update a JNDI Queue object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "updateMsgVpnJndiQueue", + "description": "Update a Cache Instance object. Any attribute missing from the request will be left unchanged.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x||x\nclusterName|x||x\ninstanceName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDistributedCacheClusterInstance", "parameters": [ { "description": "The name of the Message VPN.", @@ -51331,19 +47909,33 @@ "type": "string" }, { - "description": "The JNDI name of the JMS Queue.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "queueName", + "name": "cacheName", "required": true, "type": "string" }, { - "description": "The JNDI Queue object's attributes.", + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Instance object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnJndiQueue" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" } }, { @@ -51361,9 +47953,9 @@ ], "responses": { "200": { - "description": "The JNDI Queue object's attributes after being updated, and the request metadata.", + "description": "The Cache Instance object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" } }, "default": { @@ -51378,17 +47970,17 @@ "basicAuth": [] } ], - "summary": "Update a JNDI Queue object.", + "summary": "Update a Cache Instance object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, "put": { - "description": "Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "replaceMsgVpnJndiQueue", + "description": "Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x||x\nclusterName|x||x\ninstanceName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDistributedCacheClusterInstance", "parameters": [ { "description": "The name of the Message VPN.", @@ -51398,19 +47990,33 @@ "type": "string" }, { - "description": "The JNDI name of the JMS Queue.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "queueName", + "name": "cacheName", "required": true, "type": "string" }, { - "description": "The JNDI Queue object's attributes.", + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Instance object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnJndiQueue" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" } }, { @@ -51428,9 +48034,9 @@ ], "responses": { "200": { - "description": "The JNDI Queue object's attributes after being replaced, and the request metadata.", + "description": "The Cache Instance object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" } }, "default": { @@ -51445,19 +48051,19 @@ "basicAuth": [] } ], - "summary": "Replace a JNDI Queue object.", + "summary": "Replace a Cache Instance object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/jndiTopics": { + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics": { "get": { - "description": "Get a list of JNDI Topic objects.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", - "operationId": "getMsgVpnJndiTopics", + "description": "Get a list of Topic objects.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterTopics", "parameters": [ { "description": "The name of the Message VPN.", @@ -51466,6 +48072,20 @@ "required": true, "type": "string" }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/countQuery" }, @@ -51493,9 +48113,9 @@ ], "responses": { "200": { - "description": "The list of JNDI Topic objects' attributes, and the request metadata.", + "description": "The list of Topic objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicsResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicsResponse" } }, "default": { @@ -51510,17 +48130,17 @@ "basicAuth": [] } ], - "summary": "Get a list of JNDI Topic objects.", + "summary": "Get a list of Topic objects.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "createMsgVpnJndiTopic", + "description": "Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nmsgVpnName|x|||x\ntopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -51530,12 +48150,26 @@ "type": "string" }, { - "description": "The JNDI Topic object's attributes.", + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Topic object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnJndiTopic" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" } }, { @@ -51553,9 +48187,9 @@ ], "responses": { "200": { - "description": "The JNDI Topic object's attributes after being created, and the request metadata.", + "description": "The Topic object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" } }, "default": { @@ -51570,19 +48204,19 @@ "basicAuth": [] } ], - "summary": "Create a JNDI Topic object.", + "summary": "Create a Topic object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/jndiTopics/{topicName}": { + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}": { "delete": { - "description": "Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "deleteMsgVpnJndiTopic", + "description": "Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -51592,70 +48226,26 @@ "type": "string" }, { - "description": "The JNDI name of the JMS Topic.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "topicName", + "name": "cacheName", "required": true, "type": "string" }, { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete a JNDI Topic object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a JNDI Topic object.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "getMsgVpnJndiTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The name of the Cache Cluster.", "in": "path", - "name": "msgVpnName", + "name": "clusterName", "required": true, "type": "string" }, { - "description": "The JNDI name of the JMS Topic.", + "description": "The value of the Topic in the form a/b/c.", "in": "path", - "name": "topicName", + "name": "topic", "required": true, "type": "string" }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, { "$ref": "#/parameters/solSessionHeader" } @@ -51665,9 +48255,9 @@ ], "responses": { "200": { - "description": "The JNDI Topic object's attributes, and the request metadata.", + "description": "The request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicResponse" + "$ref": "#/definitions/SempMetaOnlyResponse" } }, "default": { @@ -51682,17 +48272,17 @@ "basicAuth": [] } ], - "summary": "Get a JNDI Topic object.", + "summary": "Delete a Topic object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false }, - "patch": { - "description": "Update a JNDI Topic object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "updateMsgVpnJndiTopic", + "get": { + "description": "Get a Topic object.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -51702,88 +48292,26 @@ "type": "string" }, { - "description": "The JNDI name of the JMS Topic.", + "description": "The name of the Distributed Cache.", "in": "path", - "name": "topicName", + "name": "cacheName", "required": true, "type": "string" }, { - "description": "The JNDI Topic object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiTopic" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Topic object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a JNDI Topic object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", - "operationId": "replaceMsgVpnJndiTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", + "description": "The name of the Cache Cluster.", "in": "path", - "name": "msgVpnName", + "name": "clusterName", "required": true, "type": "string" }, { - "description": "The JNDI name of the JMS Topic.", + "description": "The value of the Topic in the form a/b/c.", "in": "path", - "name": "topicName", + "name": "topic", "required": true, "type": "string" }, - { - "description": "The JNDI Topic object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiTopic" - } - }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -51799,9 +48327,9 @@ ], "responses": { "200": { - "description": "The JNDI Topic object's attributes after being replaced, and the request metadata.", + "description": "The Topic object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicResponse" + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" } }, "default": { @@ -51816,19 +48344,19 @@ "basicAuth": [] } ], - "summary": "Replace a JNDI Topic object.", + "summary": "Get a Topic object.", "tags": [ "all", "msgVpn", - "jndi" + "distributedCache" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaReceivers": { + "/msgVpns/{msgVpnName}/dmrBridges": { "get": { - "description": "Get a list of Kafka Receiver objects.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaReceivers", + "description": "Get a list of DMR Bridge objects.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDmrBridges", "parameters": [ { "description": "The name of the Message VPN.", @@ -51864,9 +48392,9 @@ ], "responses": { "200": { - "description": "The list of Kafka Receiver objects' attributes, and the request metadata.", + "description": "The list of DMR Bridge objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiversResponse" + "$ref": "#/definitions/MsgVpnDmrBridgesResponse" } }, "default": { @@ -51881,17 +48409,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Kafka Receiver objects.", + "summary": "Get a list of DMR Bridge objects.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "dmrBridge" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a Kafka Receiver object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaReceiverName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "createMsgVpnKafkaReceiver", + "description": "Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nremoteNodeName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDmrBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -51901,12 +48429,12 @@ "type": "string" }, { - "description": "The Kafka Receiver object's attributes.", + "description": "The DMR Bridge object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiver" + "$ref": "#/definitions/MsgVpnDmrBridge" } }, { @@ -51924,9 +48452,9 @@ ], "responses": { "200": { - "description": "The Kafka Receiver object's attributes after being created, and the request metadata.", + "description": "The DMR Bridge object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverResponse" + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" } }, "default": { @@ -51941,19 +48469,19 @@ "basicAuth": [] } ], - "summary": "Create a Kafka Receiver object.", + "summary": "Create a DMR Bridge object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "dmrBridge" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}": { + "/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}": { "delete": { - "description": "Delete a Kafka Receiver object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "deleteMsgVpnKafkaReceiver", + "description": "Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDmrBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -51963,9 +48491,9 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", + "description": "The name of the node at the remote end of the DMR Bridge.", "in": "path", - "name": "kafkaReceiverName", + "name": "remoteNodeName", "required": true, "type": "string" }, @@ -51995,17 +48523,17 @@ "basicAuth": [] } ], - "summary": "Delete a Kafka Receiver object.", + "summary": "Delete a DMR Bridge object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "dmrBridge" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a Kafka Receiver object.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaReceiver", + "description": "Get a DMR Bridge object.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDmrBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -52015,9 +48543,9 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", + "description": "The name of the node at the remote end of the DMR Bridge.", "in": "path", - "name": "kafkaReceiverName", + "name": "remoteNodeName", "required": true, "type": "string" }, @@ -52036,9 +48564,9 @@ ], "responses": { "200": { - "description": "The Kafka Receiver object's attributes, and the request metadata.", + "description": "The DMR Bridge object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverResponse" + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" } }, "default": { @@ -52053,17 +48581,17 @@ "basicAuth": [] } ], - "summary": "Get a Kafka Receiver object.", + "summary": "Get a DMR Bridge object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "dmrBridge" ], "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Kafka Receiver object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\ngroupId|||||x|\ngroupKeepaliveInterval|||||x|\ngroupKeepaliveTimeout|||||x|\ngroupMembershipType|||||x|\ngroupPartitionSchemeList|||||x|\nkafkaReceiverName|x|x||||\nmetadataTopicExcludeList|||||x|\nmetadataTopicRefreshInterval|||||x|\nmsgVpnName|x||x|||\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "updateMsgVpnKafkaReceiver", + "description": "Update a DMR Bridge object. Any attribute missing from the request will be left unchanged.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nremoteNodeName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDmrBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -52073,19 +48601,19 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", + "description": "The name of the node at the remote end of the DMR Bridge.", "in": "path", - "name": "kafkaReceiverName", + "name": "remoteNodeName", "required": true, "type": "string" }, { - "description": "The Kafka Receiver object's attributes.", + "description": "The DMR Bridge object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiver" + "$ref": "#/definitions/MsgVpnDmrBridge" } }, { @@ -52103,9 +48631,9 @@ ], "responses": { "200": { - "description": "The Kafka Receiver object's attributes after being updated, and the request metadata.", + "description": "The DMR Bridge object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverResponse" + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" } }, "default": { @@ -52120,17 +48648,17 @@ "basicAuth": [] } ], - "summary": "Update a Kafka Receiver object.", + "summary": "Update a DMR Bridge object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "dmrBridge" ], "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Kafka Receiver object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\ngroupId|||||x|\ngroupKeepaliveInterval|||||x|\ngroupKeepaliveTimeout|||||x|\ngroupMembershipType|||||x|\ngroupPartitionSchemeList|||||x|\nkafkaReceiverName|x|x||||\nmetadataTopicExcludeList|||||x|\nmetadataTopicRefreshInterval|||||x|\nmsgVpnName|x||x|||\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "replaceMsgVpnKafkaReceiver", + "description": "Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nremoteNodeName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDmrBridge", "parameters": [ { "description": "The name of the Message VPN.", @@ -52140,19 +48668,19 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", + "description": "The name of the node at the remote end of the DMR Bridge.", "in": "path", - "name": "kafkaReceiverName", + "name": "remoteNodeName", "required": true, "type": "string" }, { - "description": "The Kafka Receiver object's attributes.", + "description": "The DMR Bridge object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiver" + "$ref": "#/definitions/MsgVpnDmrBridge" } }, { @@ -52170,9 +48698,9 @@ ], "responses": { "200": { - "description": "The Kafka Receiver object's attributes after being replaced, and the request metadata.", + "description": "The DMR Bridge object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverResponse" + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" } }, "default": { @@ -52187,19 +48715,19 @@ "basicAuth": [] } ], - "summary": "Replace a Kafka Receiver object.", + "summary": "Replace a DMR Bridge object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "dmrBridge" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}/topicBindings": { + "/msgVpns/{msgVpnName}/jndiConnectionFactories": { "get": { - "description": "Get a list of Topic Binding objects.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaReceiverName|x\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaReceiverTopicBindings", + "description": "Get a list of JNDI Connection Factory objects.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnectionFactoryName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", + "operationId": "getMsgVpnJndiConnectionFactories", "parameters": [ { "description": "The name of the Message VPN.", @@ -52208,13 +48736,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Kafka Receiver.", - "in": "path", - "name": "kafkaReceiverName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -52242,9 +48763,9 @@ ], "responses": { "200": { - "description": "The list of Topic Binding objects' attributes, and the request metadata.", + "description": "The list of JNDI Connection Factory objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBindingsResponse" + "$ref": "#/definitions/MsgVpnJndiConnectionFactoriesResponse" } }, "default": { @@ -52259,17 +48780,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Topic Binding objects.", + "summary": "Get a list of JNDI Connection Factory objects.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "jndi" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nkafkaReceiverName|x|||x\nmsgVpnName|x|||x\ntopicName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "createMsgVpnKafkaReceiverTopicBinding", + "description": "Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "createMsgVpnJndiConnectionFactory", "parameters": [ { "description": "The name of the Message VPN.", @@ -52279,19 +48800,12 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", - "in": "path", - "name": "kafkaReceiverName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Binding object's attributes.", + "description": "The JNDI Connection Factory object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBinding" + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" } }, { @@ -52309,9 +48823,9 @@ ], "responses": { "200": { - "description": "The Topic Binding object's attributes after being created, and the request metadata.", + "description": "The JNDI Connection Factory object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBindingResponse" + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" } }, "default": { @@ -52326,19 +48840,19 @@ "basicAuth": [] } ], - "summary": "Create a Topic Binding object.", + "summary": "Create a JNDI Connection Factory object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "jndi" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}/topicBindings/{topicName}": { + "/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}": { "delete": { - "description": "Delete a Topic Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "deleteMsgVpnKafkaReceiverTopicBinding", + "description": "Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "deleteMsgVpnJndiConnectionFactory", "parameters": [ { "description": "The name of the Message VPN.", @@ -52348,16 +48862,9 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", - "in": "path", - "name": "kafkaReceiverName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic.", + "description": "The name of the JMS Connection Factory.", "in": "path", - "name": "topicName", + "name": "connectionFactoryName", "required": true, "type": "string" }, @@ -52387,17 +48894,17 @@ "basicAuth": [] } ], - "summary": "Delete a Topic Binding object.", + "summary": "Delete a JNDI Connection Factory object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "jndi" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic Binding object.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaReceiverName|x\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaReceiverTopicBinding", + "description": "Get a JNDI Connection Factory object.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnectionFactoryName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "getMsgVpnJndiConnectionFactory", "parameters": [ { "description": "The name of the Message VPN.", @@ -52407,16 +48914,9 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", - "in": "path", - "name": "kafkaReceiverName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic.", + "description": "The name of the JMS Connection Factory.", "in": "path", - "name": "topicName", + "name": "connectionFactoryName", "required": true, "type": "string" }, @@ -52435,9 +48935,9 @@ ], "responses": { "200": { - "description": "The Topic Binding object's attributes, and the request metadata.", + "description": "The JNDI Connection Factory object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBindingResponse" + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" } }, "default": { @@ -52452,17 +48952,17 @@ "basicAuth": [] } ], - "summary": "Get a Topic Binding object.", + "summary": "Get a JNDI Connection Factory object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "jndi" ], "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Topic Binding object. Any attribute missing from the request will be left unchanged.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ninitialOffset||||x\nkafkaReceiverName|x||x|\nlocalKey||||x\nlocalTopic||||x\nmsgVpnName|x||x|\ntopicName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "updateMsgVpnKafkaReceiverTopicBinding", + "description": "Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nconnectionFactoryName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "updateMsgVpnJndiConnectionFactory", "parameters": [ { "description": "The name of the Message VPN.", @@ -52472,26 +48972,19 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", - "in": "path", - "name": "kafkaReceiverName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic.", + "description": "The name of the JMS Connection Factory.", "in": "path", - "name": "topicName", + "name": "connectionFactoryName", "required": true, "type": "string" }, { - "description": "The Topic Binding object's attributes.", + "description": "The JNDI Connection Factory object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBinding" + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" } }, { @@ -52509,9 +49002,9 @@ ], "responses": { "200": { - "description": "The Topic Binding object's attributes after being updated, and the request metadata.", + "description": "The JNDI Connection Factory object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBindingResponse" + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" } }, "default": { @@ -52526,17 +49019,17 @@ "basicAuth": [] } ], - "summary": "Update a Topic Binding object.", + "summary": "Update a JNDI Connection Factory object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "jndi" ], "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Topic Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ninitialOffset||||x\nkafkaReceiverName|x||x|\nlocalKey||||x\nlocalTopic||||x\nmsgVpnName|x||x|\ntopicName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "replaceMsgVpnKafkaReceiverTopicBinding", + "description": "Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nconnectionFactoryName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "replaceMsgVpnJndiConnectionFactory", "parameters": [ { "description": "The name of the Message VPN.", @@ -52546,26 +49039,19 @@ "type": "string" }, { - "description": "The name of the Kafka Receiver.", - "in": "path", - "name": "kafkaReceiverName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic.", + "description": "The name of the JMS Connection Factory.", "in": "path", - "name": "topicName", + "name": "connectionFactoryName", "required": true, "type": "string" }, { - "description": "The Topic Binding object's attributes.", + "description": "The JNDI Connection Factory object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBinding" + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" } }, { @@ -52583,9 +49069,9 @@ ], "responses": { "200": { - "description": "The Topic Binding object's attributes after being replaced, and the request metadata.", + "description": "The JNDI Connection Factory object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaReceiverTopicBindingResponse" + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" } }, "default": { @@ -52600,19 +49086,19 @@ "basicAuth": [] } ], - "summary": "Replace a Topic Binding object.", + "summary": "Replace a JNDI Connection Factory object.", "tags": [ "all", "msgVpn", - "kafkaReceiver" + "jndi" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaSenders": { + "/msgVpns/{msgVpnName}/jndiQueues": { "get": { - "description": "Get a list of Kafka Sender objects.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaSenders", + "description": "Get a list of JNDI Queue objects.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", + "operationId": "getMsgVpnJndiQueues", "parameters": [ { "description": "The name of the Message VPN.", @@ -52648,9 +49134,9 @@ ], "responses": { "200": { - "description": "The list of Kafka Sender objects' attributes, and the request metadata.", + "description": "The list of JNDI Queue objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSendersResponse" + "$ref": "#/definitions/MsgVpnJndiQueuesResponse" } }, "default": { @@ -52665,17 +49151,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Kafka Sender objects.", + "summary": "Get a list of JNDI Queue objects.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a Kafka Sender object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaSenderName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "createMsgVpnKafkaSender", + "description": "Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "createMsgVpnJndiQueue", "parameters": [ { "description": "The name of the Message VPN.", @@ -52685,12 +49171,12 @@ "type": "string" }, { - "description": "The Kafka Sender object's attributes.", + "description": "The JNDI Queue object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaSender" + "$ref": "#/definitions/MsgVpnJndiQueue" } }, { @@ -52708,9 +49194,9 @@ ], "responses": { "200": { - "description": "The Kafka Sender object's attributes after being created, and the request metadata.", + "description": "The JNDI Queue object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderResponse" + "$ref": "#/definitions/MsgVpnJndiQueueResponse" } }, "default": { @@ -52725,19 +49211,19 @@ "basicAuth": [] } ], - "summary": "Create a Kafka Sender object.", + "summary": "Create a JNDI Queue object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}": { + "/msgVpns/{msgVpnName}/jndiQueues/{queueName}": { "delete": { - "description": "Delete a Kafka Sender object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "deleteMsgVpnKafkaSender", + "description": "Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "deleteMsgVpnJndiQueue", "parameters": [ { "description": "The name of the Message VPN.", @@ -52747,9 +49233,9 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", + "description": "The JNDI name of the JMS Queue.", "in": "path", - "name": "kafkaSenderName", + "name": "queueName", "required": true, "type": "string" }, @@ -52779,17 +49265,17 @@ "basicAuth": [] } ], - "summary": "Delete a Kafka Sender object.", + "summary": "Delete a JNDI Queue object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a Kafka Sender object.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaSender", + "description": "Get a JNDI Queue object.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "getMsgVpnJndiQueue", "parameters": [ { "description": "The name of the Message VPN.", @@ -52799,9 +49285,9 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", + "description": "The JNDI name of the JMS Queue.", "in": "path", - "name": "kafkaSenderName", + "name": "queueName", "required": true, "type": "string" }, @@ -52820,9 +49306,9 @@ ], "responses": { "200": { - "description": "The Kafka Sender object's attributes, and the request metadata.", + "description": "The JNDI Queue object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderResponse" + "$ref": "#/definitions/MsgVpnJndiQueueResponse" } }, "default": { @@ -52837,17 +49323,17 @@ "basicAuth": [] } ], - "summary": "Get a Kafka Sender object.", + "summary": "Get a JNDI Queue object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Kafka Sender object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxMsgCount|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\nidempotenceEnabled|||||x|\nkafkaSenderName|x|x||||\nmsgVpnName|x||x|||\ntransportCompressionEnabled|||||x|\ntransportCompressionLevel|||||x|\ntransportCompressionType|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "updateMsgVpnKafkaSender", + "description": "Update a JNDI Queue object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "updateMsgVpnJndiQueue", "parameters": [ { "description": "The name of the Message VPN.", @@ -52857,19 +49343,19 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", + "description": "The JNDI name of the JMS Queue.", "in": "path", - "name": "kafkaSenderName", + "name": "queueName", "required": true, "type": "string" }, { - "description": "The Kafka Sender object's attributes.", + "description": "The JNDI Queue object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaSender" + "$ref": "#/definitions/MsgVpnJndiQueue" } }, { @@ -52887,9 +49373,9 @@ ], "responses": { "200": { - "description": "The Kafka Sender object's attributes after being updated, and the request metadata.", + "description": "The JNDI Queue object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderResponse" + "$ref": "#/definitions/MsgVpnJndiQueueResponse" } }, "default": { @@ -52904,17 +49390,17 @@ "basicAuth": [] } ], - "summary": "Update a Kafka Sender object.", + "summary": "Update a JNDI Queue object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Kafka Sender object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxMsgCount|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\nidempotenceEnabled|||||x|\nkafkaSenderName|x|x||||\nmsgVpnName|x||x|||\ntransportCompressionEnabled|||||x|\ntransportCompressionLevel|||||x|\ntransportCompressionType|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "replaceMsgVpnKafkaSender", + "description": "Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "replaceMsgVpnJndiQueue", "parameters": [ { "description": "The name of the Message VPN.", @@ -52924,19 +49410,19 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", + "description": "The JNDI name of the JMS Queue.", "in": "path", - "name": "kafkaSenderName", + "name": "queueName", "required": true, "type": "string" }, { - "description": "The Kafka Sender object's attributes.", + "description": "The JNDI Queue object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaSender" + "$ref": "#/definitions/MsgVpnJndiQueue" } }, { @@ -52954,9 +49440,9 @@ ], "responses": { "200": { - "description": "The Kafka Sender object's attributes after being replaced, and the request metadata.", + "description": "The JNDI Queue object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderResponse" + "$ref": "#/definitions/MsgVpnJndiQueueResponse" } }, "default": { @@ -52971,19 +49457,19 @@ "basicAuth": [] } ], - "summary": "Replace a Kafka Sender object.", + "summary": "Replace a JNDI Queue object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}/queueBindings": { + "/msgVpns/{msgVpnName}/jndiTopics": { "get": { - "description": "Get a list of Queue Binding objects.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaSenderName|x\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaSenderQueueBindings", + "description": "Get a list of JNDI Topic objects.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", + "operationId": "getMsgVpnJndiTopics", "parameters": [ { "description": "The name of the Message VPN.", @@ -52992,13 +49478,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the Kafka Sender.", - "in": "path", - "name": "kafkaSenderName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -53026,9 +49505,9 @@ ], "responses": { "200": { - "description": "The list of Queue Binding objects' attributes, and the request metadata.", + "description": "The list of JNDI Topic objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBindingsResponse" + "$ref": "#/definitions/MsgVpnJndiTopicsResponse" } }, "default": { @@ -53043,17 +49522,17 @@ "basicAuth": [] } ], - "summary": "Get a list of Queue Binding objects.", + "summary": "Get a list of JNDI Topic objects.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "post": { - "description": "Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nkafkaSenderName|x|||x\nmsgVpnName|x|||x\nqueueName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "createMsgVpnKafkaSenderQueueBinding", + "description": "Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "createMsgVpnJndiTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -53063,19 +49542,12 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", - "in": "path", - "name": "kafkaSenderName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Binding object's attributes.", + "description": "The JNDI Topic object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBinding" + "$ref": "#/definitions/MsgVpnJndiTopic" } }, { @@ -53093,9 +49565,9 @@ ], "responses": { "200": { - "description": "The Queue Binding object's attributes after being created, and the request metadata.", + "description": "The JNDI Topic object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBindingResponse" + "$ref": "#/definitions/MsgVpnJndiTopicResponse" } }, "default": { @@ -53110,19 +49582,19 @@ "basicAuth": [] } ], - "summary": "Create a Queue Binding object.", + "summary": "Create a JNDI Topic object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}/queueBindings/{queueName}": { + "/msgVpns/{msgVpnName}/jndiTopics/{topicName}": { "delete": { - "description": "Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "deleteMsgVpnKafkaSenderQueueBinding", + "description": "Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "deleteMsgVpnJndiTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -53132,16 +49604,9 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", - "in": "path", - "name": "kafkaSenderName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", + "description": "The JNDI name of the JMS Topic.", "in": "path", - "name": "queueName", + "name": "topicName", "required": true, "type": "string" }, @@ -53171,17 +49636,17 @@ "basicAuth": [] } ], - "summary": "Delete a Queue Binding object.", + "summary": "Delete a JNDI Topic object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "get": { - "description": "Get a Queue Binding object.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaSenderName|x\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "getMsgVpnKafkaSenderQueueBinding", + "description": "Get a JNDI Topic object.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "getMsgVpnJndiTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -53191,16 +49656,9 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", - "in": "path", - "name": "kafkaSenderName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", + "description": "The JNDI name of the JMS Topic.", "in": "path", - "name": "queueName", + "name": "topicName", "required": true, "type": "string" }, @@ -53219,9 +49677,9 @@ ], "responses": { "200": { - "description": "The Queue Binding object's attributes, and the request metadata.", + "description": "The JNDI Topic object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBindingResponse" + "$ref": "#/definitions/MsgVpnJndiTopicResponse" } }, "default": { @@ -53236,17 +49694,17 @@ "basicAuth": [] } ], - "summary": "Get a Queue Binding object.", + "summary": "Get a JNDI Topic object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Queue Binding object. Any attribute missing from the request will be left unchanged.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nackMode||||x\nkafkaSenderName|x||x|\nmsgVpnName|x||x|\npartitionConsistentHash||||x\npartitionExplicitNumber||||x\npartitionRandomFallbackEnabled||||x\npartitionScheme||||x\nqueueName|x|x||\nremoteKey||||x\nremoteTopic||||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "updateMsgVpnKafkaSenderQueueBinding", + "description": "Update a JNDI Topic object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "updateMsgVpnJndiTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -53256,26 +49714,19 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", - "in": "path", - "name": "kafkaSenderName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", + "description": "The JNDI name of the JMS Topic.", "in": "path", - "name": "queueName", + "name": "topicName", "required": true, "type": "string" }, { - "description": "The Queue Binding object's attributes.", + "description": "The JNDI Topic object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBinding" + "$ref": "#/definitions/MsgVpnJndiTopic" } }, { @@ -53293,9 +49744,9 @@ ], "responses": { "200": { - "description": "The Queue Binding object's attributes after being updated, and the request metadata.", + "description": "The JNDI Topic object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBindingResponse" + "$ref": "#/definitions/MsgVpnJndiTopicResponse" } }, "default": { @@ -53310,17 +49761,17 @@ "basicAuth": [] } ], - "summary": "Update a Queue Binding object.", + "summary": "Update a JNDI Topic object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nackMode||||x\nkafkaSenderName|x||x|\nmsgVpnName|x||x|\npartitionConsistentHash||||x\npartitionExplicitNumber||||x\npartitionRandomFallbackEnabled||||x\npartitionScheme||||x\nqueueName|x|x||\nremoteKey||||x\nremoteTopic||||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", - "operationId": "replaceMsgVpnKafkaSenderQueueBinding", + "description": "Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", + "operationId": "replaceMsgVpnJndiTopic", "parameters": [ { "description": "The name of the Message VPN.", @@ -53330,26 +49781,19 @@ "type": "string" }, { - "description": "The name of the Kafka Sender.", - "in": "path", - "name": "kafkaSenderName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", + "description": "The JNDI name of the JMS Topic.", "in": "path", - "name": "queueName", + "name": "topicName", "required": true, "type": "string" }, { - "description": "The Queue Binding object's attributes.", + "description": "The JNDI Topic object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBinding" + "$ref": "#/definitions/MsgVpnJndiTopic" } }, { @@ -53367,9 +49811,9 @@ ], "responses": { "200": { - "description": "The Queue Binding object's attributes after being replaced, and the request metadata.", + "description": "The JNDI Topic object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnKafkaSenderQueueBindingResponse" + "$ref": "#/definitions/MsgVpnJndiTopicResponse" } }, "default": { @@ -53384,11 +49828,11 @@ "basicAuth": [] } ], - "summary": "Replace a Queue Binding object.", + "summary": "Replace a JNDI Topic object.", "tags": [ "all", "msgVpn", - "kafkaSender" + "jndi" ], "x-supportedInSempDirect": false } @@ -53766,7 +50210,7 @@ }, "/msgVpns/{msgVpnName}/mqttSessions": { "get": { - "description": "Get a list of MQTT Session objects.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of MQTT Session objects.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnMqttSessions", "parameters": [ { @@ -53829,7 +50273,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x|x|\nmqttSessionVirtualRouter|x|x|x|\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x|x|\nmqttSessionVirtualRouter|x|x|x|\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "createMsgVpnMqttSession", "parameters": [ { @@ -53891,7 +50335,7 @@ }, "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}": { "delete": { - "description": "Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "deleteMsgVpnMqttSession", "parameters": [ { @@ -53950,7 +50394,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an MQTT Session object.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get an MQTT Session object.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnMqttSession", "parameters": [ { @@ -54015,7 +50459,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an MQTT Session object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||\nmqttSessionVirtualRouter|x|x||\nmsgVpnName|x||x|\nowner||||x\nqueueRejectMsgToSenderOnDiscardBehavior||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update an MQTT Session object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||\nmqttSessionVirtualRouter|x|x||\nmsgVpnName|x||x|\nowner||||x\nqueueRejectMsgToSenderOnDiscardBehavior||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "updateMsgVpnMqttSession", "parameters": [ { @@ -54089,7 +50533,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||\nmqttSessionVirtualRouter|x|x||\nmsgVpnName|x||x|\nowner||||x\nqueueRejectMsgToSenderOnDiscardBehavior||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||\nmqttSessionVirtualRouter|x|x||\nmsgVpnName|x||x|\nowner||||x\nqueueRejectMsgToSenderOnDiscardBehavior||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "replaceMsgVpnMqttSession", "parameters": [ { @@ -54165,7 +50609,7 @@ }, "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions": { "get": { - "description": "Get a list of Subscription objects.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of Subscription objects.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnMqttSessionSubscriptions", "parameters": [ { @@ -54242,7 +50686,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||x\nmqttSessionVirtualRouter|x|||x\nmsgVpnName|x|||x\nsubscriptionTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||x\nmqttSessionVirtualRouter|x|||x\nmsgVpnName|x|||x\nsubscriptionTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "createMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54318,7 +50762,7 @@ }, "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}": { "delete": { - "description": "Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "deleteMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54384,7 +50828,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Subscription object.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get a Subscription object.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54456,7 +50900,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Subscription object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmqttSessionClientId|x||x\nmqttSessionVirtualRouter|x||x\nmsgVpnName|x||x\nsubscriptionTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update a Subscription object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmqttSessionClientId|x||x\nmqttSessionVirtualRouter|x||x\nmsgVpnName|x||x\nsubscriptionTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "updateMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54537,7 +50981,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmqttSessionClientId|x||x\nmqttSessionVirtualRouter|x||x\nmsgVpnName|x||x\nsubscriptionTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmqttSessionClientId|x||x\nmqttSessionVirtualRouter|x||x\nmsgVpnName|x||x\nsubscriptionTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "replaceMsgVpnMqttSessionSubscription", "parameters": [ { @@ -56634,7 +53078,7 @@ }, "/msgVpns/{msgVpnName}/replicatedTopics": { "get": { - "description": "Get a list of Replicated Topic objects.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of Replicated Topic objects.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnReplicatedTopics", "parameters": [ { @@ -56697,7 +53141,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplicatedTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplicatedTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "createMsgVpnReplicatedTopic", "parameters": [ { @@ -56759,7 +53203,7 @@ }, "/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}": { "delete": { - "description": "Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "deleteMsgVpnReplicatedTopic", "parameters": [ { @@ -56811,7 +53255,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Replicated Topic object.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get a Replicated Topic object.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnReplicatedTopic", "parameters": [ { @@ -56869,7 +53313,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Replicated Topic object. Any attribute missing from the request will be left unchanged.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplicatedTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update a Replicated Topic object. Any attribute missing from the request will be left unchanged.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplicatedTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "updateMsgVpnReplicatedTopic", "parameters": [ { @@ -56936,7 +53380,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplicatedTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplicatedTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "replaceMsgVpnReplicatedTopic", "parameters": [ { @@ -61653,7 +58097,7 @@ }, "/msgVpns/{msgVpnName}/topicEndpoints": { "get": { - "description": "Get a list of Topic Endpoint objects.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of Topic Endpoint objects.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnTopicEndpoints", "parameters": [ { @@ -61716,7 +58160,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicEndpointName|x|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicEndpointName|x|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "createMsgVpnTopicEndpoint", "parameters": [ { @@ -61778,7 +58222,7 @@ }, "/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}": { "delete": { - "description": "Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "deleteMsgVpnTopicEndpoint", "parameters": [ { @@ -61830,7 +58274,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic Endpoint object.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get a Topic Endpoint object.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "getMsgVpnTopicEndpoint", "parameters": [ { @@ -61888,7 +58332,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\ntopicEndpointName|x|x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\ntopicEndpointName|x|x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "updateMsgVpnTopicEndpoint", "parameters": [ { @@ -61955,7 +58399,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\ntopicEndpointName|x|x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\ntopicEndpointName|x|x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.4.", "operationId": "replaceMsgVpnTopicEndpoint", "parameters": [ { @@ -64549,7 +60993,7 @@ "/systemInformation": { "get": { "deprecated": true, - "description": "Get a System Information object.\n\nThe System Information object provides metadata about the SEMP API.\n\n\nAttribute|Deprecated\n:---|:---:\nplatform|x\nsempVersion|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been deprecated since 2.2. /systemInformation was replaced by /about/api.", + "description": "Get a System Information object.\n\nThe System Information object provides metadata about the SEMP API.\n\n\nAttribute|Deprecated\n:---|:---:\nplatform|x\nsempVersion|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been deprecated since 2.4. /systemInformation was replaced by /about/api.", "operationId": "getSystemInformation", "parameters": [ { diff --git a/ci/template-test/main.tf b/ci/template-test/main.tf index b0a50aa..bcfdd71 100644 --- a/ci/template-test/main.tf +++ b/ci/template-test/main.tf @@ -2,6 +2,7 @@ provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "messaging_endpoint_1" { diff --git a/ci/template-test/providers.tf b/ci/template-test/providers.tf index c96b421..440c98f 100644 --- a/ci/template-test/providers.tf +++ b/ci/template-test/providers.tf @@ -3,7 +3,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/exclusive-queue/README.md b/examples/exclusive-queue/README.md index 2700ee3..c071549 100644 --- a/examples/exclusive-queue/README.md +++ b/examples/exclusive-queue/README.md @@ -15,7 +15,7 @@ Configuration in this directory creates an [exclusive queue](https://docs.solace The `access_type` module input variable defines if a queue is "exclusive" or "non-exclusive". The default is "exclusive", so the variable doesn't need to be strictly specified. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output @@ -44,7 +44,7 @@ cd examples/exclusive-queue ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/exclusive-queue/main.tf b/examples/exclusive-queue/main.tf index 5f52559..4531037 100644 --- a/examples/exclusive-queue/main.tf +++ b/examples/exclusive-queue/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "exclusive_queue" { diff --git a/examples/exclusive-queue/providers.tf b/examples/exclusive-queue/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/exclusive-queue/providers.tf +++ b/examples/exclusive-queue/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/non-exclusive-queue/README.md b/examples/non-exclusive-queue/README.md index 444b253..fe2ea0e 100644 --- a/examples/non-exclusive-queue/README.md +++ b/examples/non-exclusive-queue/README.md @@ -15,7 +15,7 @@ Configuration in this directory creates a [non-exclusive queue](https://docs.sol The `access_type` module input variable defines if a queue is "exclusive" or "non-exclusive". This needs to be specified for a "non-exclusive" queue. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output @@ -44,7 +44,7 @@ cd examples/non-exclusive-queue ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/non-exclusive-queue/main.tf b/examples/non-exclusive-queue/main.tf index ff78518..22f447f 100644 --- a/examples/non-exclusive-queue/main.tf +++ b/examples/non-exclusive-queue/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "non_exclusive_queue" { diff --git a/examples/non-exclusive-queue/providers.tf b/examples/non-exclusive-queue/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/non-exclusive-queue/providers.tf +++ b/examples/non-exclusive-queue/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/partitioned-queue/README.md b/examples/partitioned-queue/README.md index d0d25c7..157bd30 100644 --- a/examples/partitioned-queue/README.md +++ b/examples/partitioned-queue/README.md @@ -19,7 +19,7 @@ A partitioned queue is a queue with "non-exclusive" access type and greater than * `partition_count`: greater than zero partitionals needs to be specified * `partition_rebalance_delay` and `partition_rebalance_max_handoff_time` are additional optional configurations specifically related to partitioned queues -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output @@ -48,7 +48,7 @@ cd examples/partitioned-queue ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/partitioned-queue/main.tf b/examples/partitioned-queue/main.tf index 11351b2..ae1e6df 100644 --- a/examples/partitioned-queue/main.tf +++ b/examples/partitioned-queue/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "partitioned_queue" { diff --git a/examples/partitioned-queue/providers.tf b/examples/partitioned-queue/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/partitioned-queue/providers.tf +++ b/examples/partitioned-queue/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/queue-template/README.md b/examples/queue-template/README.md index 8f9dfaf..1fd0017 100644 --- a/examples/queue-template/README.md +++ b/examples/queue-template/README.md @@ -15,7 +15,7 @@ Configuration in this directory creates a [queue template](https://docs.solace.c This example specifies an optional attribute `respect_ttl_enabled` of the queue template for demo purposes. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue_template"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue_template#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue_template"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional). ### Output @@ -44,7 +44,7 @@ cd examples/queue-template ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/queue-template/main.tf b/examples/queue-template/main.tf index 9391aa5..e3d66f3 100644 --- a/examples/queue-template/main.tf +++ b/examples/queue-template/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "queue_template" { diff --git a/examples/queue-template/providers.tf b/examples/queue-template/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/queue-template/providers.tf +++ b/examples/queue-template/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/queue-with-jndi/README.md b/examples/queue-with-jndi/README.md index 9f0e44f..e78a68d 100644 --- a/examples/queue-with-jndi/README.md +++ b/examples/queue-with-jndi/README.md @@ -17,7 +17,7 @@ Note that exposing queues as JNDI objects also requires JNDI enabled at the Mess * `jndi_queue_name`: if provided then the queue will be exposed to JNDI under this name -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output @@ -49,7 +49,7 @@ cd examples/queue-with-jndi ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/queue-with-jndi/main.tf b/examples/queue-with-jndi/main.tf index e089f01..2a2dd47 100644 --- a/examples/queue-with-jndi/main.tf +++ b/examples/queue-with-jndi/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "queue_with_jndi" { diff --git a/examples/queue-with-jndi/providers.tf b/examples/queue-with-jndi/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/queue-with-jndi/providers.tf +++ b/examples/queue-with-jndi/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/queue-with-topic-subscriptions/README.md b/examples/queue-with-topic-subscriptions/README.md index e4c8207..57b279e 100644 --- a/examples/queue-with-topic-subscriptions/README.md +++ b/examples/queue-with-topic-subscriptions/README.md @@ -17,7 +17,7 @@ A list of subscriptions to one or more topics may be specified for the queue. To * `queue_subscription_topics`: the list of topics as strings to subscribe to. Omitting this parameter or an empty list means no subscription. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_queue#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional). ### Output @@ -49,7 +49,7 @@ cd examples/queue-with-topic-subscriptions ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/queue-with-topic-subscriptions/main.tf b/examples/queue-with-topic-subscriptions/main.tf index 347b993..6034a9f 100644 --- a/examples/queue-with-topic-subscriptions/main.tf +++ b/examples/queue-with-topic-subscriptions/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "queue_with_topic_subscriptions" { diff --git a/examples/queue-with-topic-subscriptions/providers.tf b/examples/queue-with-topic-subscriptions/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/queue-with-topic-subscriptions/providers.tf +++ b/examples/queue-with-topic-subscriptions/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/topic-endpoint-template/README.md b/examples/topic-endpoint-template/README.md index a9fd5da..9ef0d17 100644 --- a/examples/topic-endpoint-template/README.md +++ b/examples/topic-endpoint-template/README.md @@ -17,7 +17,7 @@ Important: The topic subscription that a topic endpoint will spool messages for This example specifies an optional attribute `respect_ttl_enabled` of the topic endpoint template for demo purposes. -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint_template"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_topic_endpoint_template#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint_template"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#optional). ### Output @@ -46,7 +46,7 @@ cd examples/topic-endpoint-template ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/topic-endpoint-template/main.tf b/examples/topic-endpoint-template/main.tf index f3a811d..f4018f1 100644 --- a/examples/topic-endpoint-template/main.tf +++ b/examples/topic-endpoint-template/main.tf @@ -16,6 +16,7 @@ provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "topic_endpoint_template" { diff --git a/examples/topic-endpoint-template/providers.tf b/examples/topic-endpoint-template/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/topic-endpoint-template/providers.tf +++ b/examples/topic-endpoint-template/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/topic-endpoint-with-jndi/README.md b/examples/topic-endpoint-with-jndi/README.md index 56ddcb9..df7b233 100644 --- a/examples/topic-endpoint-with-jndi/README.md +++ b/examples/topic-endpoint-with-jndi/README.md @@ -17,7 +17,7 @@ Note that exposing topics as JNDI objects also requires JNDI enabled at the Mess * `jndi_topic_name`: if provided then the topic endpoint will be exposed to JNDI under this name -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_topic_endpoint#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional). ### Output @@ -49,7 +49,7 @@ cd examples/topic-endpoint-with-jndi ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/topic-endpoint-with-jndi/main.tf b/examples/topic-endpoint-with-jndi/main.tf index 6232012..88fa80d 100644 --- a/examples/topic-endpoint-with-jndi/main.tf +++ b/examples/topic-endpoint-with-jndi/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "topic_endpoint_with_jndi" { diff --git a/examples/topic-endpoint-with-jndi/providers.tf b/examples/topic-endpoint-with-jndi/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/topic-endpoint-with-jndi/providers.tf +++ b/examples/topic-endpoint-with-jndi/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/examples/topic-endpoint/README.md b/examples/topic-endpoint/README.md index abdf200..210e9c6 100644 --- a/examples/topic-endpoint/README.md +++ b/examples/topic-endpoint/README.md @@ -17,7 +17,7 @@ Important: The topic subscription that a topic endpoint will spool messages for Note that the `access_type` module input variable defines if a topic endpoint is "exclusive" or "non-exclusive". The default is "exclusive". -Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_topic_endpoint#optional). +Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_topic_endpoint"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional). ### Output @@ -46,7 +46,7 @@ cd examples/topic-endpoint ### Adjust Provider Configuration -Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. +Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker. ### Create the resource diff --git a/examples/topic-endpoint/main.tf b/examples/topic-endpoint/main.tf index a4211d0..77177ae 100644 --- a/examples/topic-endpoint/main.tf +++ b/examples/topic-endpoint/main.tf @@ -1,21 +1,22 @@ -# Copyright 2024 Solace Corporation. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - +# Copyright 2024 Solace Corporation. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + provider "solacebroker" { username = "admin" password = "admin" url = "http://localhost:8080" + skip_api_check = true } module "topic_endpoint" { diff --git a/examples/topic-endpoint/providers.tf b/examples/topic-endpoint/providers.tf index 29ed64b..c67f81b 100644 --- a/examples/topic-endpoint/providers.tf +++ b/examples/topic-endpoint/providers.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/internal/gen-template/provider.tf b/internal/gen-template/provider.tf index 060f7e6..f4433a0 100644 --- a/internal/gen-template/provider.tf +++ b/internal/gen-template/provider.tf @@ -3,7 +3,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } } diff --git a/provider.tf b/provider.tf index 256ae39..1df4291 100644 --- a/provider.tf +++ b/provider.tf @@ -17,7 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebrokerappliance" version = "~> 0.9" } }