diff --git a/.github/workflows/module-test-pipeline.yml b/.github/workflows/module-test-pipeline.yml index 78b05fa..121bb56 100644 --- a/.github/workflows/module-test-pipeline.yml +++ b/.github/workflows/module-test-pipeline.yml @@ -38,3 +38,76 @@ jobs: shopt -s extglob for d in examples/!(adding-headers)/; do (ci/scripts/test-module.sh "$d"); done ci/scripts/test-module.sh examples/adding-headers/ -var-file=secret.tfvars + + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: "1.22" + + - name: Checkout generator + uses: actions/checkout@v4 + with: + repository: SolaceDev/broker-terraform-code-generator + token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT + path: broker-terraform-code-generator + ref: "main" + + - name: Build and install generator + run: | + pushd broker-terraform-code-generator + go install . + ls ~/go/bin + popd + + - name: Generate provider code + run: | + 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 + + - name: Add copyright headers where needed + run: | + go install github.com/google/addlicense@latest + addlicense -c 'Solace Corporation. All rights reserved.' -v -l apache ./*.tf + addlicense -c 'Solace Corporation. All rights reserved.' -v -l apache $(find ./examples -name "*.tf" -type f -print0 | xargs -0) + + - name: Ensure version reflects release candidate version + run: | + # only if ${GITHUB_REF_NAME} starts with 'v' or 'dev' and followed by a semver + if [[ $GITHUB_REF_NAME =~ ^(v|dev)[0-9]+\.[0-9]+\.[0-9]+.*$ ]]; then + VERSION=$(echo "${GITHUB_REF_NAME}" | cut -d'v' -f2) + echo $VERSION > VERSION + fi + + - name: Check changed files + uses: tj-actions/verify-changed-files@v17 + id: check-changed-files + with: + files: | + !broker-terraform-code-generator + + - name: Run step only when any of the above files change. + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + echo "Changed files: ${{ steps.check-changed-files.outputs.changed_files }}" + + - name: Commit back any updated source code + if: steps.check-changed-files.outputs.files_changed == 'true' + uses: EndBug/add-and-commit@v9 + with: + committer_name: GitHub Actions + committer_email: actions@github.com + message: 'Updating generated source' + add: ". ':!broker-terraform-code-generator'" + new_branch: GeneratedSourceUpdates-${{ github.ref_name }} + + - name: Create pull request + if: steps.check-changed-files.outputs.files_changed == 'true' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + CURRENT_BRANCH=${GITHUB_REF_NAME} + gh pr create -B ${CURRENT_BRANCH} -H "GeneratedSourceUpdates-${CURRENT_BRANCH}" --title "Merge updates into ${CURRENT_BRANCH}" --body 'Created by Github action' + echo Review and approve PR before push can continue + exit 1 // force actions stop here \ No newline at end of file diff --git a/VERSION b/VERSION index 9ad3f36..fffb250 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.1.0-rc.4 +0.1.0-rc.5 diff --git a/ci/module-test/providers.tf b/ci/module-test/providers.tf index d1de478..7d3de5d 100644 --- a/ci/module-test/providers.tf +++ b/ci/module-test/providers.tf @@ -3,7 +3,8 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebroker" + version = "~> 0.9" } } required_version = "~> 1.2" diff --git a/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.lm.json b/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.lm.json deleted file mode 100644 index 9e17bed..0000000 --- a/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.0.34.lm.json +++ /dev/null @@ -1,61378 +0,0 @@ -{ - "basePath": "/SEMP/v2/config", - "consumes": [ - "application/json" - ], - "definitions": { - "About": { - "properties": {}, - "type": "object" - }, - "AboutApi": { - "properties": { - "platform": { - "description": "The platform running the SEMP API.", - "maxLength": 10, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "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.", - "maxLength": 10, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "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 - } - }, - "type": "object" - }, - "AboutApiLinks": { - "properties": { - "uri": { - "description": "The URI of this API Description object.", - "type": "string" - } - }, - "type": "object" - }, - "AboutApiResponse": { - "properties": { - "data": { - "$ref": "#/definitions/AboutApi" - }, - "links": { - "$ref": "#/definitions/AboutApiLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "AboutLinks": { - "properties": { - "apiUri": { - "description": "The URI of this About's API Description object. Available since 2.4.", - "type": "string" - }, - "uri": { - "description": "The URI of this About object.", - "type": "string" - }, - "userUri": { - "description": "The URI of this About's User object. Available since 2.4.", - "type": "string" - } - }, - "type": "object" - }, - "AboutResponse": { - "properties": { - "data": { - "$ref": "#/definitions/About" - }, - "links": { - "$ref": "#/definitions/AboutLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "AboutUser": { - "properties": { - "globalAccessLevel": { - "description": "The global access level of the User. The allowed values and their meaning are:\n\n
\n\"admin\" - Full administrative access.\n\"none\" - No access.\n\"read-only\" - Read only access.\n\"read-write\" - Read and write access.\n
\n", - "enum": [ - "admin", - "none", - "read-only", - "read-write" - ], - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "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 - }, - "globalDmrBridgeAccessEnabled": { - "description": "Indicates whether global DMR Bridge access is enabled for the User. This is only for Solace internal use. This attribute may not be returned in a GET. Available since (hidden in public API).", - "type": "boolean", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "sessionActive": { - "description": "Indicates whether a session is active for this request. Available since 2.24.", - "type": "boolean", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "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 - }, - "sessionCreateTime": { - "description": "The timestamp of when the session was created. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", - "format": "int32", - "maximum": 2147483647, - "minimum": -2147483648, - "type": "integer", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "sessionCurrentTime": { - "description": "The current server timestamp. This is provided as a reference point for the other timestamps provided. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", - "format": "int32", - "maximum": 2147483647, - "minimum": -2147483648, - "type": "integer", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "sessionHardExpiryTime": { - "description": "The hard expiry time for the session. After this time the session will be invalid, regardless of activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", - "format": "int32", - "maximum": 2147483647, - "minimum": -2147483648, - "type": "integer", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "sessionId": { - "description": "An identifier for the session to differentiate this session from other sessions for the same user. This value is not guaranteed to be unique between active sessions for different users. This attribute may not be returned in a GET. Available since 2.21.", - "maxLength": 56, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "sessionIdleExpiryTime": { - "description": "The session idle expiry time. After this time the session will be invalid if there has been no activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", - "format": "int32", - "maximum": 2147483647, - "minimum": -2147483648, - "type": "integer", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "username": { - "description": "The username of the User. Available since 2.21.", - "maxLength": 32, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "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 - } - }, - "type": "object" - }, - "AboutUserLinks": { - "properties": { - "msgVpnsUri": { - "description": "The URI of this User's collection of User Message VPN objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this User object.", - "type": "string" - } - }, - "type": "object" - }, - "AboutUserMsgVpn": { - "properties": { - "accessLevel": { - "description": "The Message VPN access level of the User. The allowed values and their meaning are:\n\n
\n\"none\" - No access.\n\"read-only\" - Read only access.\n\"read-write\" - Read and write access.\n
\n", - "enum": [ - "none", - "read-only", - "read-write" - ], - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "x-autoDisable": [], - "x-deprecated": false, - "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 - }, - "msgVpnName": { - "description": "The name of the Message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "global/none" - }, - "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" - }, - "AboutUserMsgVpnLinks": { - "properties": { - "uri": { - "description": "The URI of this User Message VPN object.", - "type": "string" - } - }, - "type": "object" - }, - "AboutUserMsgVpnResponse": { - "properties": { - "data": { - "$ref": "#/definitions/AboutUserMsgVpn" - }, - "links": { - "$ref": "#/definitions/AboutUserMsgVpnLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "AboutUserMsgVpnsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/AboutUserMsgVpn" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/AboutUserMsgVpnLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "AboutUserResponse": { - "properties": { - "data": { - "$ref": "#/definitions/AboutUser" - }, - "links": { - "$ref": "#/definitions/AboutUserLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "Broker": { - "properties": { - "authClientCertRevocationCheckMode": { - "description": "The client certificate revocation checking mode used when a client authenticates with a client certificate. 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\" - Do not perform any certificate revocation checking.\n\"ocsp\" - Use the Open Certificate Status Protcol (OCSP) for certificate revocation checking.\n\"crl\" - Use Certificate Revocation Lists (CRL) for certificate revocation checking.\n\"ocsp-crl\" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL.\n
\n", - "enum": [ - "none", - "ocsp", - "crl", - "ocsp-crl" - ], - "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 - }, - "configSyncAuthenticationClientCertMaxChainDepth": { - "description": "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The default value is `3`. Available since 2.22.", - "format": "int64", - "maximum": 8, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3, - "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 - }, - "configSyncAuthenticationClientCertValidateDateEnabled": { - "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the authentication certificate(s). The default value is `true`. Available since 2.22.", - "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 - }, - "configSyncClientProfileTcpInitialCongestionWindow": { - "description": "The TCP initial congestion window size for Config Sync clients, 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. The default value is `2`. Available since 2.22.", - "format": "int64", - "maximum": 7826, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 2, - "x-default": 2, - "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 - }, - "configSyncClientProfileTcpKeepaliveCount": { - "description": "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The default value is `5`. Available since 2.22.", - "format": "int64", - "maximum": 5, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 5, - "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 - }, - "configSyncClientProfileTcpKeepaliveIdle": { - "description": "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The default value is `3`. Available since 2.22.", - "format": "int64", - "maximum": 120, - "minimum": 3, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3, - "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 - }, - "configSyncClientProfileTcpKeepaliveInterval": { - "description": "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgment is received, in seconds. The default value is `1`. Available since 2.22.", - "format": "int64", - "maximum": 30, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "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 - }, - "configSyncClientProfileTcpMaxWindow": { - "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. The default value is `256`. Available since 2.22.", - "format": "int64", - "maximum": 65536, - "minimum": 16, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 256, - "x-default": 256, - "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 - }, - "configSyncClientProfileTcpMss": { - "description": "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The default value is `1460`. Available since 2.22.", - "format": "int64", - "maximum": 1460, - "minimum": 256, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1460, - "x-default": 1460, - "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 - }, - "configSyncEnabled": { - "description": "Enable or disable configuration synchronization for High Availability or Disaster Recovery. The default value is `false`. Available since 2.22.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "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 - }, - "configSyncSynchronizeUsernameEnabled": { - "description": "Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.22.", - "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 - }, - "configSyncTlsEnabled": { - "description": "Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The default value is `false`. Available since 2.22.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "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 - }, - "guaranteedMsgingDefragmentationScheduleDayList": { - "description": "The days of the week to schedule defragmentation runs, specified as \"daily\" or as a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Please note \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Available since 2.25.", - "maxLength": 100, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "daily", - "x-configSyncTableType": "router", - "x-default": "daily", - "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 - }, - "guaranteedMsgingDefragmentationScheduleEnabled": { - "description": "Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "guaranteedMsgingDefragmentationScheduleTimeList": { - "description": "The times of the day to schedule defragmentation runs, specified as \"hourly\" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"0:00\"`. Available since 2.25.", - "maxLength": 100, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "0:00", - "x-configSyncTableType": "router", - "x-default": "0:00", - "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 - }, - "guaranteedMsgingDefragmentationThresholdEnabled": { - "description": "Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "guaranteedMsgingDefragmentationThresholdFragmentationPercentage": { - "description": "Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.", - "format": "int64", - "maximum": 100, - "minimum": 30, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 50, - "x-configSyncTableType": "router", - "x-default": 50, - "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 - }, - "guaranteedMsgingDefragmentationThresholdMinInterval": { - "description": "Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.25.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 15, - "x-configSyncTableType": "router", - "x-default": 15, - "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 - }, - "guaranteedMsgingDefragmentationThresholdUsagePercentage": { - "description": "Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.", - "format": "int64", - "maximum": 100, - "minimum": 30, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 50, - "x-configSyncTableType": "router", - "x-default": 50, - "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 - }, - "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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "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 - }, - "guaranteedMsgingEventCacheUsageThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventCacheUsageThreshold" - }, - "guaranteedMsgingEventDeliveredUnackedThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventDeliveredUnackedThreshold" - }, - "guaranteedMsgingEventDiskUsageThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventDiskUsageThreshold" - }, - "guaranteedMsgingEventEgressFlowCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventEgressFlowCountThreshold" - }, - "guaranteedMsgingEventEndpointCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventEndpointCountThreshold" - }, - "guaranteedMsgingEventIngressFlowCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventIngressFlowCountThreshold" - }, - "guaranteedMsgingEventMsgCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventMsgCountThreshold" - }, - "guaranteedMsgingEventMsgSpoolFileCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventMsgSpoolFileCountThreshold" - }, - "guaranteedMsgingEventMsgSpoolUsageThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventMsgSpoolUsageThreshold" - }, - "guaranteedMsgingEventTransactedSessionCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventTransactedSessionCountThreshold" - }, - "guaranteedMsgingEventTransactedSessionResourceCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventTransactedSessionResourceCountThreshold" - }, - "guaranteedMsgingEventTransactionCountThreshold": { - "$ref": "#/definitions/GuaranteedMsgingEventTransactionCountThreshold" - }, - "guaranteedMsgingMaxCacheUsage": { - "description": "Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `10`. Available since 2.18.", - "format": "int32", - "maximum": 50, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 10, - "x-configSyncTableType": "router", - "x-default": 10, - "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 - }, - "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 `60000`. Available since 2.18.", - "format": "int64", - "maximum": 6000000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60000, - "x-configSyncTableType": "router", - "x-default": 60000, - "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 - }, - "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": "legacy", - "x-configSyncTableType": "router", - "x-default": "legacy", - "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 - }, - "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": [ - "primary", - "backup" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "guaranteedMsgingEnabled" - ], - "x-configSyncDefault": "primary", - "x-default": "primary", - "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 - }, - "oauthProfileDefault": { - "description": "The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.24.", - "maxLength": 32, - "minLength": 0, - "pattern": "^[A-Za-z0-9_]*$", - "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 - }, - "serviceAmqpEnabled": { - "description": "Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP 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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "serviceAmqpTlsListenPort": { - "description": "TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceAmqpEnabled 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 `0`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceAmqpEnabled" - ], - "x-configSyncDefault": 0, - "x-configSyncTableType": "router", - "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 - }, - "serviceEventConnectionCountThreshold": { - "$ref": "#/definitions/ServiceEventConnectionCountThreshold" - }, - "serviceHealthCheckEnabled": { - "description": "Enable or disable the plain-text health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "serviceHealthCheckListenPort": { - "description": "The port number for the plain-text health-check service. The port must be unique across the message backbone. The health-check 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 serviceHealthCheckEnabled 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 `5550`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceHealthCheckEnabled" - ], - "x-configSyncDefault": 5550, - "x-configSyncTableType": "router", - "x-default": 5550, - "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 - }, - "serviceHealthCheckTlsEnabled": { - "description": "Enable or disable the TLS health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.34.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "serviceHealthCheckTlsListenPort": { - "description": "The port number for the TLS health-check service. The port must be unique across the message backbone. The health-check 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 serviceHealthCheckTlsEnabled 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 `0`. Available since 2.34.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceHealthCheckTlsEnabled" - ], - "x-configSyncDefault": 0, - "x-configSyncTableType": "router", - "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 - }, - "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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "serviceMsgBackboneEnabled": { - "description": "Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. 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 - }, - "serviceRestEventOutgoingConnectionCountThreshold": { - "$ref": "#/definitions/ServiceRestEventOutgoingConnectionCountThreshold" - }, - "serviceRestIncomingEnabled": { - "description": "Enable or disable the REST service incoming connections on the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "serviceRestOutgoingEnabled": { - "description": "Enable or disable the REST service outgoing connections on the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "serviceSempCorsAllowAnyHostEnabled": { - "description": "Enable or disable cross origin resource requests for the SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.", - "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 - }, - "serviceSempLegacyTimeoutEnabled": { - "description": "Enable or disable extended SEMP timeouts for paged responses. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.18.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "serviceSempPlainTextEnabled": { - "description": "Enable or disable plain-text SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. 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-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 - }, - "serviceSempPlainTextListenPort": { - "description": "The TCP port for plain-text SEMP client connections. This attribute cannot be cannot be changed while serviceSempPlainTextEnabled are set to true. 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, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "router", - "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-requiredPost": false, - "x-requiresDisable": [ - "serviceSempPlainTextEnabled" - ], - "x-writeOnly": false - }, - "serviceSempSessionIdleTimeout": { - "description": "The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.21.", - "format": "int32", - "maximum": 5256000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 15, - "x-configSyncTableType": "router", - "x-default": 15, - "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 - }, - "serviceSempSessionMaxLifetime": { - "description": "The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `43200`. Available since 2.21.", - "format": "int32", - "maximum": 5256000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 43200, - "x-configSyncTableType": "router", - "x-default": 43200, - "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 - }, - "serviceSempTlsEnabled": { - "description": "Enable or disable TLS SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. 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-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 - }, - "serviceSempTlsListenPort": { - "description": "The TCP port for TLS SEMP client connections. This attribute cannot be cannot be changed while serviceSempTlsEnabled are set to true. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1943`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1943, - "x-configSyncTableType": "router", - "x-default": 1943, - "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": [ - "serviceSempTlsEnabled" - ], - "x-writeOnly": false - }, - "serviceSmfCompressionListenPort": { - "description": "TCP port number that SMF clients can use to connect to the broker using raw compression TCP. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is `55003`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceSmfEnabled" - ], - "x-configSyncDefault": 55003, - "x-default": 55003, - "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 - }, - "serviceSmfEnabled": { - "description": "Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. 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 - }, - "serviceSmfEventConnectionCountThreshold": { - "$ref": "#/definitions/ServiceSmfEventConnectionCountThreshold" - }, - "serviceSmfPlainTextListenPort": { - "description": "TCP port number that SMF clients can use to connect to the broker using raw TCP. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is `55555`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceSmfEnabled" - ], - "x-configSyncDefault": 55555, - "x-default": 55555, - "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 - }, - "serviceSmfRoutingControlListenPort": { - "description": "TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is `55556`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceSmfEnabled" - ], - "x-configSyncDefault": 55556, - "x-default": 55556, - "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 - }, - "serviceSmfTlsListenPort": { - "description": "TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as serviceSmfEnabled will be temporarily set to false to apply the change. The default value is `55443`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceSmfEnabled" - ], - "x-configSyncDefault": 55443, - "x-default": 55443, - "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 - }, - "serviceTlsEventConnectionCountThreshold": { - "$ref": "#/definitions/ServiceTlsEventConnectionCountThreshold" - }, - "serviceWebTransportEnabled": { - "description": "Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport 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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "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 `80`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceWebTransportEnabled" - ], - "x-configSyncDefault": 80, - "x-configSyncTableType": "router", - "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-requiredPost": false, - "x-requiresDisable": [], - "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 `443`. Available since 2.17.", - "format": "int64", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceWebTransportEnabled" - ], - "x-configSyncDefault": 443, - "x-configSyncTableType": "router", - "x-default": 443, - "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 - }, - "serviceWebTransportWebUrlSuffix": { - "description": "Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. 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. The default value is `\"\"`. Available since 2.17.", - "maxLength": 127, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceWebTransportEnabled" - ], - "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 - }, - "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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "tlsCipherSuiteManagementList": { - "description": "The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.", - "maxLength": 1559, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "default", - "x-configSyncTableType": "router", - "x-default": "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 - }, - "tlsCipherSuiteMsgBackboneList": { - "description": "The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.", - "maxLength": 1559, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "default", - "x-configSyncTableType": "router", - "x-default": "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 - }, - "tlsCipherSuiteSecureShellList": { - "description": "The colon-separated list of cipher suites used for TLS secure shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.", - "maxLength": 1559, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "default", - "x-configSyncTableType": "router", - "x-default": "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 - }, - "tlsCrimeExploitProtectionEnabled": { - "description": "Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. 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 - }, - "tlsServerCertContent": { - "description": "The PEM formatted content for the server certificate used for TLS connections. 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. The default value is `\"\"`.", - "maxLength": 32768, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "global/admin" - }, - "x-autoDisable": [], - "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 - }, - "tlsServerCertPassword": { - "description": "The password for the server certificate used for TLS connections. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. The default value is `\"\"`.", - "maxLength": 512, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "global/admin" - }, - "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": true, - "x-requiredPost": false, - "x-requires": [ - "tlsServerCertContent" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "tlsStandardDomainCertificateAuthoritiesEnabled": { - "description": "Enable or disable the standard domain certificate authority list. The default value is `true`. Available since 2.19.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/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 - }, - "tlsTicketLifetime": { - "description": "The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", - "format": "int32", - "maximum": 86400, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "router", - "x-default": 86400, - "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 - }, - "webManagerAllowUnencryptedWizardsEnabled": { - "description": "Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.28.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "webManagerCustomization": { - "description": "Reserved for internal use by Solace. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.25.", - "maxLength": 1024, - "minLength": 0, - "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 - }, - "webManagerRedirectHttpEnabled": { - "description": "Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/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 - }, - "webManagerRedirectHttpOverrideTlsPort": { - "description": "The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.24.", - "format": "int32", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "router", - "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": "object" - }, - "BrokerLinks": { - "properties": { - "aboutUri": { - "description": "The URI of this Broker's About object.", - "type": "string" - }, - "certAuthoritiesUri": { - "description": "The URI of this Broker's collection of Certificate Authority objects. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "type": "string" - }, - "clientCertAuthoritiesUri": { - "description": "The URI of this Broker's collection of Client Certificate Authority objects. Available since 2.19.", - "type": "string" - }, - "dmrClustersUri": { - "description": "The URI of this Broker's collection of Cluster objects. Available since 2.11.", - "type": "string" - }, - "domainCertAuthoritiesUri": { - "description": "The URI of this Broker's collection of Domain Certificate Authority objects. Available since 2.19.", - "type": "string" - }, - "msgVpnsUri": { - "description": "The URI of this Broker's collection of Message VPN objects. Available since 2.0.", - "type": "string" - }, - "oauthProfilesUri": { - "description": "The URI of this Broker's collection of OAuth Profile objects. Available since 2.24.", - "type": "string" - }, - "systemInformationUri": { - "description": "The URI of this Broker's System Information object. Deprecated since 2.4. /systemInformation was replaced by /about/api.", - "type": "string" - }, - "uri": { - "description": "The URI of this Broker object.", - "type": "string" - }, - "virtualHostnamesUri": { - "description": "The URI of this Broker's collection of Virtual Hostname objects. Available since 2.17.", - "type": "string" - } - }, - "type": "object" - }, - "BrokerResponse": { - "properties": { - "data": { - "$ref": "#/definitions/Broker" - }, - "links": { - "$ref": "#/definitions/BrokerLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "CertAuthoritiesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/CertAuthority" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/CertAuthorityLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "CertAuthority": { - "properties": { - "certAuthorityName": { - "description": "The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9_\\-.]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "certContent": { - "description": "The PEM formatted content for the trusted root certificate of a Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "maxLength": 32768, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "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 - }, - "crlDayList": { - "description": "The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "maxLength": 100, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "daily", - "x-configSyncTableType": "router", - "x-default": "daily", - "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-requires": [ - "crlTimeList" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "crlTimeList": { - "description": "The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "maxLength": 100, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "3:00", - "x-configSyncTableType": "router", - "x-default": "3:00", - "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-requires": [ - "crlDayList" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "crlUrl": { - "description": "The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. IPv6 addresses must be enclosed in square-brackets. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as revocationCheckEnabled 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 `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "maxLength": 2048, - "minLength": 0, - "pattern": "^(.+://.+)?$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [ - "revocationCheckEnabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "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 - }, - "ocspNonResponderCertEnabled": { - "description": "Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "router", - "x-default": false, - "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 - }, - "ocspOverrideUrl": { - "description": "The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "maxLength": 2048, - "minLength": 0, - "pattern": "^((.|..|...|....|[^h]....|.[^t]...|..[^t]..|...[^p].|....[^s]|.......*)://.+)?$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "x-default": "", - "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 - }, - "ocspTimeout": { - "description": "The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "format": "int64", - "maximum": 86400, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": 5, - "x-configSyncTableType": "router", - "x-default": 5, - "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 - }, - "revocationCheckEnabled": { - "description": "Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "router", - "x-default": false, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "CertAuthorityLinks": { - "properties": { - "ocspTlsTrustedCommonNamesUri": { - "description": "The URI of this Certificate Authority's collection of OCSP Responder Trusted Common Name objects. Deprecated since 2.19. Replaced by clientCertAuthorities.", - "type": "string" - }, - "uri": { - "description": "The URI of this Certificate Authority object.", - "type": "string" - } - }, - "type": "object" - }, - "CertAuthorityOcspTlsTrustedCommonName": { - "properties": { - "certAuthorityName": { - "description": "The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9_\\-.]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "ocspTlsTrustedCommonName": { - "description": "The expected Trusted Common Name of the OCSP responder remote certificate. Deprecated since 2.19. Replaced by clientCertAuthorities.", - "maxLength": 64, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "CertAuthorityOcspTlsTrustedCommonNameLinks": { - "properties": { - "uri": { - "description": "The URI of this OCSP Responder Trusted Common Name object.", - "type": "string" - } - }, - "type": "object" - }, - "CertAuthorityOcspTlsTrustedCommonNameResponse": { - "properties": { - "data": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonName" - }, - "links": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "CertAuthorityOcspTlsTrustedCommonNamesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonName" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "CertAuthorityResponse": { - "properties": { - "data": { - "$ref": "#/definitions/CertAuthority" - }, - "links": { - "$ref": "#/definitions/CertAuthorityLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "ClientCertAuthoritiesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/ClientCertAuthority" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/ClientCertAuthorityLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "ClientCertAuthority": { - "properties": { - "certAuthorityName": { - "description": "The name of the Certificate Authority.", - "maxLength": 64, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "certContent": { - "description": "The PEM formatted content for the trusted root certificate of a client Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 32768, - "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 - }, - "crlDayList": { - "description": "The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlTimeList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`.", - "maxLength": 100, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "daily", - "x-configSyncTableType": "router", - "x-default": "daily", - "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-requires": [ - "crlTimeList" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "crlTimeList": { - "description": "The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlDayList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`.", - "maxLength": 100, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "3:00", - "x-configSyncTableType": "router", - "x-default": "3:00", - "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-requires": [ - "crlDayList" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "crlUrl": { - "description": "The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. IPv6 addresses must be enclosed in square-brackets. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as revocationCheckEnabled 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 `\"\"`.", - "maxLength": 2048, - "minLength": 0, - "pattern": "^(.+://.+)?$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [ - "revocationCheckEnabled" - ], - "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 - }, - "ocspNonResponderCertEnabled": { - "description": "Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "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 - }, - "ocspOverrideUrl": { - "description": "The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 2048, - "minLength": 0, - "pattern": "^((.|..|...|....|[^h]....|.[^t]...|..[^t]..|...[^p].|....[^s]|.......*)://.+)?$", - "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 - }, - "ocspTimeout": { - "description": "The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`.", - "format": "int64", - "maximum": 86400, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": 5, - "x-configSyncTableType": "router", - "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 - }, - "revocationCheckEnabled": { - "description": "Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "ClientCertAuthorityLinks": { - "properties": { - "ocspTlsTrustedCommonNamesUri": { - "description": "The URI of this Client Certificate Authority's collection of OCSP Responder Trusted Common Name objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Client Certificate Authority object.", - "type": "string" - } - }, - "type": "object" - }, - "ClientCertAuthorityOcspTlsTrustedCommonName": { - "properties": { - "certAuthorityName": { - "description": "The name of the Certificate Authority.", - "maxLength": 64, - "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 - }, - "ocspTlsTrustedCommonName": { - "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", - "maxLength": 64, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "ClientCertAuthorityOcspTlsTrustedCommonNameLinks": { - "properties": { - "uri": { - "description": "The URI of this OCSP Responder Trusted Common Name object.", - "type": "string" - } - }, - "type": "object" - }, - "ClientCertAuthorityOcspTlsTrustedCommonNameResponse": { - "properties": { - "data": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonName" - }, - "links": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "ClientCertAuthorityOcspTlsTrustedCommonNamesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonName" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "ClientCertAuthorityResponse": { - "properties": { - "data": { - "$ref": "#/definitions/ClientCertAuthority" - }, - "links": { - "$ref": "#/definitions/ClientCertAuthorityLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrCluster": { - "properties": { - "authenticationBasicEnabled": { - "description": "Enable or disable basic authentication for Cluster Links. 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 - }, - "authenticationBasicPassword": { - "description": "The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. 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 via config-sync. The default value is `\"\"`.", - "maxLength": 128, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "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 - }, - "authenticationBasicType": { - "description": "The type of basic authentication to use for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are:\n\n
\n\"internal\" - Use locally configured password.\n\"none\" - No authentication.\n
\n", - "enum": [ - "internal", - "none" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "internal", - "x-configSyncTableType": "router", - "x-default": "internal", - "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 - }, - "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used to login to the remote node. 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 `\"\"`.", - "maxLength": 32768, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "global/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 - }, - "authenticationClientCertEnabled": { - "description": "Enable or disable client certificate authentication for Cluster Links. 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 - }, - "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", - "x-accessLevels": { - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", - "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": [ - "authenticationClientCertContent" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "directOnlyEnabled": { - "description": "Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-default": false, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "dmrClusterName": { - "description": "The name of the Cluster.", - "maxLength": 64, - "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 - }, - "enabled": { - "description": "Enable or disable the Cluster. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "nodeName": { - "description": "The name of this node in the Cluster. This is the name that this broker (or redundant group of brokers) is know by to other nodes in the Cluster. The name is chosen automatically to be either this broker's Router Name or Mate Router Name, depending on which Active Standby Role (primary or backup) this broker plays in its redundancy group.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[^*?'<>&/]+$", - "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": true, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "tlsServerCertEnforceTrustedCommonNameEnabled": { - "description": "Enable or disable the enforcing of the common name provided by the remote broker against the list of trusted common names configured for the Link. If enabled, the certificate's common name must match one of the trusted common names for the Link to be accepted. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "router", - "x-default": false, - "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 - }, - "tlsServerCertMaxChainDepth": { - "description": "The maximum allowed depth of a certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 8, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3, - "x-configSyncTableType": "router", - "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 - }, - "tlsServerCertValidateDateEnabled": { - "description": "Enable or disable the validation of the \"Not Before\" and \"Not After\" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. 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 - }, - "tlsServerCertValidateNameEnabled": { - "description": "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote broker. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.18.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "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": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "DmrClusterCertMatchingRule": { - "properties": { - "dmrClusterName": { - "description": "The name of the Cluster.", - "maxLength": 64, - "minLength": 1, - "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 - }, - "enabled": { - "description": "Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "ruleName": { - "description": "The name of the rule.", - "maxLength": 64, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "DmrClusterCertMatchingRuleAttributeFilter": { - "properties": { - "attributeName": { - "description": "Link Attribute to be tested. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, - "pattern": "^([A-Za-z][A-Za-z0-9\\-]*)?$", - "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 - }, - "attributeValue": { - "description": "Expected attribute value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 256, - "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 - }, - "dmrClusterName": { - "description": "The name of the Cluster.", - "maxLength": 64, - "minLength": 1, - "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 - }, - "filterName": { - "description": "The name of the filter.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[^#*? ]([^*?]*[^*? ])?$", - "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 - }, - "ruleName": { - "description": "The name of the rule.", - "maxLength": 64, - "minLength": 1, - "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" - }, - "DmrClusterCertMatchingRuleAttributeFilterLinks": { - "properties": { - "uri": { - "description": "The URI of this Certificate Matching Rule Attribute Filter object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterCertMatchingRuleAttributeFilterResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" - }, - "links": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterCertMatchingRuleAttributeFiltersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterCertMatchingRuleCondition": { - "properties": { - "attribute": { - "description": "Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, - "pattern": "^([A-Za-z][A-Za-z0-9\\-]*)?$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "dmrClusterName": { - "description": "The name of the Cluster.", - "maxLength": 64, - "minLength": 1, - "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 - }, - "expression": { - "description": "Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`.", - "maxLength": 256, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "ruleName": { - "description": "The name of the rule.", - "maxLength": 64, - "minLength": 1, - "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 - }, - "source": { - "description": "Certificate field to be compared with the Attribute. The allowed values and their meaning are:\n\n
\n\"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.\n\"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.\n\"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.\n\"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.\n\"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.\n\"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.\n\"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN.\n\"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN.\n\"issuer\" - The attribute is extracted from the certificate's Issuer DN.\n\"subject\" - The attribute is extracted from the certificate's Subject DN.\n\"serial-number\" - The attribute is extracted from the certificate's Serial Number.\n\"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNS Name.\n\"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IP Address.\n
\n", - "enum": [ - "certificate-thumbprint", - "common-name", - "common-name-last", - "subject-alternate-name-msupn", - "uid", - "uid-last", - "org-unit", - "org-unit-last", - "issuer", - "subject", - "serial-number", - "dns-name", - "ip-address" - ], - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "DmrClusterCertMatchingRuleConditionLinks": { - "properties": { - "uri": { - "description": "The URI of this Certificate Matching Rule Condition object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterCertMatchingRuleConditionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" - }, - "links": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterCertMatchingRuleConditionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterCertMatchingRuleLinks": { - "properties": { - "attributeFiltersUri": { - "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects.", - "type": "string" - }, - "conditionsUri": { - "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Certificate Matching Rule object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterCertMatchingRuleResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" - }, - "links": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterCertMatchingRulesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLink": { - "properties": { - "authenticationBasicPassword": { - "description": "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. 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 via config-sync. The default value is `\"\"`.", - "maxLength": 128, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "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 - }, - "authenticationScheme": { - "description": "The authentication scheme to be used by the Link which initiates connections to the remote node. 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 via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are:\n\n
\n\"basic\" - Basic Authentication Scheme (via username and password).\n\"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content).\n
\n", - "enum": [ - "basic", - "client-certificate" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "basic", - "x-configSyncTableType": "router", - "x-default": "basic", - "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 - }, - "clientProfileQueueControl1MaxDepth": { - "description": "The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "router", - "x-default": 20000, - "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 - }, - "clientProfileQueueControl1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "router", - "x-default": 4, - "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 - }, - "clientProfileQueueDirect1MaxDepth": { - "description": "The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "router", - "x-default": 20000, - "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 - }, - "clientProfileQueueDirect1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "router", - "x-default": 4, - "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 - }, - "clientProfileQueueDirect2MaxDepth": { - "description": "The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "router", - "x-default": 20000, - "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 - }, - "clientProfileQueueDirect2MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "router", - "x-default": 4, - "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 - }, - "clientProfileQueueDirect3MaxDepth": { - "description": "The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "router", - "x-default": 20000, - "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 - }, - "clientProfileQueueDirect3MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "router", - "x-default": 4, - "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 - }, - "clientProfileQueueGuaranteed1MaxDepth": { - "description": "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "router", - "x-default": 20000, - "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 - }, - "clientProfileQueueGuaranteed1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-1) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 255, - "x-configSyncTableType": "router", - "x-default": 255, - "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 - }, - "clientProfileTcpCongestionWindowSize": { - "description": "The TCP initial congestion window size, 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 via config-sync. The default value is `2`.", - "format": "int64", - "maximum": 7826, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 2, - "x-configSyncTableType": "router", - "x-default": 2, - "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 - }, - "clientProfileTcpKeepaliveCount": { - "description": "The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`.", - "format": "int64", - "maximum": 5, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 5, - "x-configSyncTableType": "router", - "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 - }, - "clientProfileTcpKeepaliveIdleTime": { - "description": "The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 120, - "minimum": 3, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3, - "x-configSyncTableType": "router", - "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 - }, - "clientProfileTcpKeepaliveInterval": { - "description": "The amount of time between TCP keepalive retransmissions when no acknowledgment is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", - "format": "int64", - "maximum": 30, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "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 - }, - "clientProfileTcpMaxSegmentSize": { - "description": "The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`.", - "format": "int64", - "maximum": 1460, - "minimum": 256, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1460, - "x-configSyncTableType": "router", - "x-default": 1460, - "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 - }, - "clientProfileTcpMaxWindowSize": { - "description": "The TCP maximum window size, 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 via config-sync. The default value is `256`.", - "format": "int64", - "maximum": 65536, - "minimum": 16, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 256, - "x-configSyncTableType": "router", - "x-default": 256, - "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 - }, - "dmrClusterName": { - "description": "The name of the Cluster.", - "maxLength": 64, - "minLength": 1, - "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 - }, - "egressFlowWindowSize": { - "description": "The number of outstanding guaranteed messages that can be sent over the Link before acknowledgment is received by the 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 via config-sync. The default value is `255`.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 255, - "x-configSyncTableType": "router", - "x-default": 255, - "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 - }, - "enabled": { - "description": "Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "initiator": { - "description": "The initiator of the Link's TCP connections. 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 via config-sync. The default value is `\"lexical\"`. The allowed values and their meaning are:\n\n
\n\"lexical\" - The \"higher\" node-name initiates.\n\"local\" - The local node initiates.\n\"remote\" - The remote node initiates.\n
\n", - "enum": [ - "lexical", - "local", - "remote" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "lexical", - "x-configSyncTableType": "router", - "x-default": "lexical", - "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 - }, - "queueDeadMsgQueue": { - "description": "The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[^*?'<>&;]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "#DEAD_MSG_QUEUE", - "x-configSyncTableType": "router", - "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 - }, - "queueEventSpoolUsageThreshold": { - "$ref": "#/definitions/DmrClusterLinkQueueEventSpoolUsageThreshold" - }, - "queueMaxDeliveredUnackedMsgsPerFlow": { - "description": "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1000000`.", - "format": "int64", - "maximum": 1000000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1000000, - "x-configSyncTableType": "router", - "x-default": 1000000, - "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 - }, - "queueMaxMsgSpoolUsage": { - "description": "The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `800000`.", - "format": "int64", - "maximum": 6000000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4000, - "x-configSyncTableType": "router", - "x-default": 800000, - "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 - }, - "queueMaxRedeliveryCount": { - "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 via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 255, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "router", - "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 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 Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "router", - "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. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"always\"`. 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" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "always", - "x-configSyncTableType": "router", - "x-default": "always", - "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 Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "remoteNodeName": { - "description": "The name of the node at the remote end of the Link.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[^*?'<>&/]+$", - "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 - }, - "span": { - "description": "The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. 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 via config-sync. The default value is `\"external\"`. The allowed values and their meaning are:\n\n
\n\"internal\" - Link to same cluster.\n\"external\" - Link to other cluster.\n
\n", - "enum": [ - "internal", - "external" - ], - "type": "string", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "external", - "x-configSyncTableType": "router", - "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 - }, - "transportCompressedEnabled": { - "description": "Enable or disable compression on the Link. 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 via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "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 - }, - "transportTlsEnabled": { - "description": "Enable or disable encryption (TLS) on the Link. 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 via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "DmrClusterLinkAttribute": { - "properties": { - "attributeName": { - "description": "The name of the Attribute.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z][A-Za-z0-9\\-]*$", - "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 - }, - "attributeValue": { - "description": "The value of the Attribute.", - "maxLength": 256, - "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 - }, - "dmrClusterName": { - "description": "The name of the Cluster.", - "maxLength": 64, - "minLength": 1, - "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 - }, - "remoteNodeName": { - "description": "The name of the node at the remote end of the Link.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[^*?'<>&/]+$", - "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" - }, - "DmrClusterLinkAttributeLinks": { - "properties": { - "uri": { - "description": "The URI of this Link Attribute object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterLinkAttributeResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrClusterLinkAttribute" - }, - "links": { - "$ref": "#/definitions/DmrClusterLinkAttributeLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLinkAttributesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrClusterLinkAttribute" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterLinkAttributeLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLinkLinks": { - "properties": { - "attributesUri": { - "description": "The URI of this Link's collection of Link Attribute objects. Available since 2.28.", - "type": "string" - }, - "remoteAddressesUri": { - "description": "The URI of this Link's collection of Remote Address objects.", - "type": "string" - }, - "tlsTrustedCommonNamesUri": { - "description": "The URI of this Link's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "type": "string" - }, - "uri": { - "description": "The URI of this Link object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterLinkQueueEventSpoolUsageThreshold": { - "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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "router", - "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 - }, - "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": "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": 2, - "x-configSyncTableType": "router", - "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 - }, - "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": "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" - }, - "DmrClusterLinkRemoteAddress": { - "properties": { - "dmrClusterName": { - "description": "The name of the Cluster.", - "maxLength": 64, - "minLength": 1, - "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 - }, - "remoteAddress": { - "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).", - "maxLength": 259, - "minLength": 1, - "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})$", - "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 - }, - "remoteNodeName": { - "description": "The name of the node at the remote end of the Link.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[^*?'<>&/]+$", - "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" - }, - "DmrClusterLinkRemoteAddressLinks": { - "properties": { - "uri": { - "description": "The URI of this Remote Address object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterLinkRemoteAddressResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddress" - }, - "links": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLinkRemoteAddressesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddress" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLinkResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrClusterLink" - }, - "links": { - "$ref": "#/definitions/DmrClusterLinkLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLinkTlsTrustedCommonName": { - "properties": { - "dmrClusterName": { - "description": "The name of the Cluster. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 64, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "remoteNodeName": { - "description": "The name of the node at the remote end of the Link. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[^*?'<>&/]+$", - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "tlsTrustedCommonName": { - "description": "The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 64, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "global/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "DmrClusterLinkTlsTrustedCommonNameLinks": { - "properties": { - "uri": { - "description": "The URI of this Trusted Common Name object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterLinkTlsTrustedCommonNameResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" - }, - "links": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLinkTlsTrustedCommonNamesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterLinks": { - "properties": { - "certMatchingRulesUri": { - "description": "The URI of this Cluster's collection of Certificate Matching Rule objects. Available since 2.28.", - "type": "string" - }, - "linksUri": { - "description": "The URI of this Cluster's collection of Link objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Cluster object.", - "type": "string" - } - }, - "type": "object" - }, - "DmrClusterLinksResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrClusterLink" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterLinkLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClusterResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DmrCluster" - }, - "links": { - "$ref": "#/definitions/DmrClusterLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DmrClustersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DmrCluster" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DmrClusterLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DomainCertAuthoritiesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/DomainCertAuthority" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/DomainCertAuthorityLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "DomainCertAuthority": { - "properties": { - "certAuthorityName": { - "description": "The name of the Certificate Authority.", - "maxLength": 64, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "certContent": { - "description": "The PEM formatted content for the trusted root certificate of a domain Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 32768, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/admin", - "post": "global/admin" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "DomainCertAuthorityLinks": { - "properties": { - "uri": { - "description": "The URI of this Domain Certificate Authority object.", - "type": "string" - } - }, - "type": "object" - }, - "DomainCertAuthorityResponse": { - "properties": { - "data": { - "$ref": "#/definitions/DomainCertAuthority" - }, - "links": { - "$ref": "#/definitions/DomainCertAuthorityLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "GuaranteedMsgingEventCacheUsageThreshold": { - "description": "The thresholds for the cache usage event at system level, relative to `guaranteedMsgingMaxCacheUsage`. Available since 2.18.", - "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": 4294967295, - "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": 4294967295, - "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" - }, - "GuaranteedMsgingEventDeliveredUnackedThreshold": { - "description": "The thresholds for the number of delivered but unacknowledged messages event at system level, relative to the maximum system limit. Available since 2.18.", - "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.", - "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-default": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "GuaranteedMsgingEventDiskUsageThreshold": { - "description": "The thresholds for the active disk partition usage event at system level, relative to the maximum system limit. Available since 2.18.", - "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.", - "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-default": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "GuaranteedMsgingEventEgressFlowCountThreshold": { - "description": "The thresholds for the transmit flow count event at system level, relative to the maximum system limit. Available since 2.18.", - "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": 4294967295, - "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": 4294967295, - "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" - }, - "GuaranteedMsgingEventEndpointCountThreshold": { - "description": "The thresholds for the endpoints count event at system level, relative to the maximum system limit. Available since 2.18.", - "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": 4294967295, - "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": 4294967295, - "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" - }, - "GuaranteedMsgingEventIngressFlowCountThreshold": { - "description": "The thresholds for the receive flow count event at system level, relative to the maximum system limit. Available since 2.18.", - "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": 4294967295, - "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": 4294967295, - "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" - }, - "GuaranteedMsgingEventMsgCountThreshold": { - "description": "The thresholds for the spool message count event at system level, relative to the maximum system limit. Available since 2.18.", - "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.", - "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-default": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "GuaranteedMsgingEventMsgSpoolFileCountThreshold": { - "description": "The thresholds for the spool file count event at system level, relative to the maximum system limit. Available since 2.18.", - "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.", - "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-default": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "GuaranteedMsgingEventMsgSpoolUsageThreshold": { - "description": "The thresholds for the spool usage event at system level, relative to `maxSpoolUsage`. Available since 2.18.", - "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": 4294967295, - "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": 4294967295, - "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" - }, - "GuaranteedMsgingEventTransactedSessionCountThreshold": { - "description": "The thresholds for the transacted sessions event at system level, relative to the maximum system limit. Available since 2.18.", - "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": 4294967295, - "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": 4294967295, - "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" - }, - "GuaranteedMsgingEventTransactedSessionResourceCountThreshold": { - "description": "The thresholds for the transacted session resources at system level, relative to the maximum system limit. Available since 2.18.", - "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.", - "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-default": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "GuaranteedMsgingEventTransactionCountThreshold": { - "description": "The thresholds for the transactions event at system level, relative to the maximum system limit. Available since 2.18.", - "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": 4294967295, - "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": 4294967295, - "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" - }, - "MsgVpn": { - "properties": { - "alias": { - "description": "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\nAliases may form a non-circular chain, cascading one to the next.\n\nChanges to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", - "maxLength": 32, - "minLength": 0, - "pattern": "^[^*?]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "authenticationBasicEnabled": { - "description": "Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. 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": "global/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 - }, - "authenticationBasicProfileName": { - "description": "The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", - "maxLength": 32, - "minLength": 0, - "pattern": "^[A-Za-z0-9_]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "default", - "x-configSyncTableType": "vpn", - "x-default": "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-requires": [ - "authenticationBasicType" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "authenticationBasicRadiusDomain": { - "description": "The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "authenticationBasicType": { - "description": "The type of basic authentication to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"radius\"`. The allowed values and their meaning are:\n\n
\n\"internal\" - Internal database. Authentication is against Client Usernames.\n\"ldap\" - LDAP authentication. An LDAP profile name must be provided.\n\"radius\" - RADIUS authentication. A RADIUS profile name must be provided.\n\"none\" - No authentication. Anonymous login allowed.\n
\n", - "enum": [ - "internal", - "ldap", - "radius", - "none" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "radius", - "x-configSyncTableType": "vpn", - "x-default": "radius", - "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 - }, - "authenticationClientCertAllowApiProvidedUsernameEnabled": { - "description": "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. 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": "global/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 - }, - "authenticationClientCertCertificateMatchingRulesEnabled": { - "description": "Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. 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": "global/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 - }, - "authenticationClientCertEnabled": { - "description": "Enable or disable client certificate authentication in the 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": "global/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 - }, - "authenticationClientCertMaxChainDepth": { - "description": "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 8, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "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.8.", - "enum": [ - "allow-all", - "allow-unknown", - "allow-valid" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "allow-valid", - "x-configSyncTableType": "vpn", - "x-default": "allow-valid", - "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 - }, - "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.5.", - "enum": [ - "certificate-thumbprint", - "common-name", - "common-name-last", - "subject-alternate-name-msupn", - "uid", - "uid-last" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "common-name", - "x-configSyncTableType": "vpn", - "x-default": "common-name", - "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 - }, - "authenticationClientCertValidateDateEnabled": { - "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. 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": "global/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 - }, - "authenticationKerberosAllowApiProvidedUsernameEnabled": { - "description": "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. 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": "global/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 - }, - "authenticationKerberosEnabled": { - "description": "Enable or disable Kerberos authentication in the 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": "global/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 - }, - "authenticationOauthDefaultProfileName": { - "description": "The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25.", - "maxLength": 32, - "minLength": 0, - "pattern": "^[A-Za-z0-9_]*$", - "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 - }, - "authenticationOauthDefaultProviderName": { - "description": "The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles.", - "maxLength": 31, - "minLength": 0, - "pattern": "^[^~]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "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 - }, - "authenticationOauthEnabled": { - "description": "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "authorizationLdapGroupMembershipAttributeName": { - "description": "The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`.", - "maxLength": 64, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "memberOf", - "x-configSyncTableType": "vpn", - "x-default": "memberOf", - "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 - }, - "authorizationLdapTrimClientUsernameDomainEnabled": { - "description": "Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurrence of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.", - "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 - }, - "authorizationProfileName": { - "description": "The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 32, - "minLength": 0, - "pattern": "^[A-Za-z0-9_]*$", - "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-requires": [ - "authorizationType" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "authorizationType": { - "description": "The type of authorization to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are:\n\n
\n\"ldap\" - LDAP authorization.\n\"internal\" - Internal authorization.\n
\n", - "enum": [ - "ldap", - "internal" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "internal", - "x-configSyncTableType": "vpn", - "x-default": "internal", - "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 - }, - "bridgingTlsServerCertEnforceTrustedCommonNameEnabled": { - "description": "Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "vpn", - "x-default": false, - "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 - }, - "bridgingTlsServerCertMaxChainDepth": { - "description": "The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 8, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "bridgingTlsServerCertValidateDateEnabled": { - "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. 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": "global/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 - }, - "bridgingTlsServerCertValidateNameEnabled": { - "description": "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote broker. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. 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": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "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 - }, - "distributedCacheManagementEnabled": { - "description": "Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache management is now redundancy aware and thus no longer requires administrative intervention for operational state.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-default": true, - "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 - }, - "dmrEnabled": { - "description": "Enable or disable Dynamic Message Routing (DMR) for 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.11.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "enabled": { - "description": "Enable or disable the 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 - }, - "eventConnectionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventConnectionCountThreshold" - }, - "eventEgressFlowCountThreshold": { - "$ref": "#/definitions/MsgVpnEventEgressFlowCountThreshold" - }, - "eventEgressMsgRateThreshold": { - "$ref": "#/definitions/MsgVpnEventEgressMsgRateThreshold" - }, - "eventEndpointCountThreshold": { - "$ref": "#/definitions/MsgVpnEventEndpointCountThreshold" - }, - "eventIngressFlowCountThreshold": { - "$ref": "#/definitions/MsgVpnEventIngressFlowCountThreshold" - }, - "eventIngressMsgRateThreshold": { - "$ref": "#/definitions/MsgVpnEventIngressMsgRateThreshold" - }, - "eventLargeMsgThreshold": { - "description": "The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1024, - "x-configSyncTableType": "vpn", - "x-default": 1024, - "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 - }, - "eventLogTag": { - "description": "A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites 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": [], - "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 - }, - "eventMsgSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnEventMsgSpoolUsageThreshold" - }, - "eventPublishClientEnabled": { - "description": "Enable or disable Client level Event message publishing. 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 - }, - "eventPublishMsgVpnEnabled": { - "description": "Enable or disable Message VPN level Event message publishing. 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 - }, - "eventPublishSubscriptionMode": { - "description": "Subscription level Event message publishing mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"off\"`. The allowed values and their meaning are:\n\n
\n\"off\" - Disable client level event message publishing.\n\"on-with-format-v1\" - Enable client level event message publishing with format v1.\n\"on-with-no-unsubscribe-events-on-disconnect-format-v1\" - As \"on-with-format-v1\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions.\n\"on-with-format-v2\" - Enable client level event message publishing with format v2.\n\"on-with-no-unsubscribe-events-on-disconnect-format-v2\" - As \"on-with-format-v2\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions.\n
\n", - "enum": [ - "off", - "on-with-format-v1", - "on-with-no-unsubscribe-events-on-disconnect-format-v1", - "on-with-format-v2", - "on-with-no-unsubscribe-events-on-disconnect-format-v2" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "off", - "x-configSyncTableType": "vpn", - "x-default": "off", - "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 - }, - "eventPublishTopicFormatMqttEnabled": { - "description": "Enable or disable Event publish topics in MQTT format. 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-requires": [ - "eventPublishTopicFormatSmfEnabled" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "eventPublishTopicFormatSmfEnabled": { - "description": "Enable or disable Event publish topics in SMF format. 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-requires": [ - "eventPublishTopicFormatMqttEnabled" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "eventServiceAmqpConnectionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventServiceAmqpConnectionCountThreshold" - }, - "eventServiceMqttConnectionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventServiceMqttConnectionCountThreshold" - }, - "eventServiceRestIncomingConnectionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventServiceRestIncomingConnectionCountThreshold" - }, - "eventServiceSmfConnectionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventServiceSmfConnectionCountThreshold" - }, - "eventServiceWebConnectionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventServiceWebConnectionCountThreshold" - }, - "eventSubscriptionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventSubscriptionCountThreshold" - }, - "eventTransactedSessionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventTransactedSessionCountThreshold" - }, - "eventTransactionCountThreshold": { - "$ref": "#/definitions/MsgVpnEventTransactionCountThreshold" - }, - "exportSubscriptionsEnabled": { - "description": "Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. 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": "global/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 - }, - "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.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 - }, - "maxConnectionCount": { - "description": "The maximum number of client connections 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.", - "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 - }, - "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 `16000`.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 16000, - "x-configSyncTableType": "vpn", - "x-default": 16000, - "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 - }, - "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 `16000`.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 16000, - "x-configSyncTableType": "vpn", - "x-default": 16000, - "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 - }, - "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 `16000`.", - "format": "int64", - "maximum": 1000000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 16000, - "x-configSyncTableType": "vpn", - "x-default": 16000, - "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 - }, - "maxMsgSpoolUsage": { - "description": "The maximum message spool usage by the Message VPN, in megabytes. 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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "maxSubscriptionCount": { - "description": "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", - "format": "int64", - "maximum": 4294967295, - "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 - }, - "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": 100000, - "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 - }, - "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": 100000, - "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 - }, - "mqttRetainMaxMemory": { - "description": "The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11.", - "format": "int32", - "maximum": 2147483647, - "minimum": -1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": -1, - "x-configSyncTableType": "vpn", - "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 - }, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "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", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20, - "x-configSyncTableType": "vpn", - "x-default": 20, - "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 - }, - "replicationBridgeAuthenticationBasicClientUsername": { - "description": "The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 189, - "minLength": 0, - "pattern": "^[^?*]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/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-requires": [ - "replicationBridgeAuthenticationBasicPassword" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "replicationBridgeAuthenticationBasicPassword": { - "description": "The password for the Client Username. 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": 128, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "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": [ - "replicationBridgeAuthenticationBasicClientUsername" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "replicationBridgeAuthenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. 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. The default value is `\"\"`. Available since 2.9.", - "maxLength": 32768, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "global/read-write" - }, - "x-autoDisable": [], - "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 - }, - "replicationBridgeAuthenticationClientCertPassword": { - "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. The default value is `\"\"`. Available since 2.9.", - "maxLength": 512, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "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": true, - "x-requiredPost": false, - "x-requires": [ - "replicationBridgeAuthenticationClientCertContent" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "replicationBridgeAuthenticationScheme": { - "description": "The authentication scheme for the replication Bridge in the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are:\n\n
\n\"basic\" - Basic Authentication Scheme (via username and password).\n\"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content).\n
\n", - "enum": [ - "basic", - "client-certificate" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "basic", - "x-configSyncTableType": "router", - "x-default": "basic", - "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 - }, - "replicationBridgeCompressedDataEnabled": { - "description": "Enable or disable use of compression for the replication Bridge. 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": "global/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 - }, - "replicationBridgeEgressFlowWindowSize": { - "description": "The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 255, - "x-configSyncTableType": "router", - "x-default": 255, - "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 - }, - "replicationBridgeRetryDelay": { - "description": "The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 255, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3, - "x-configSyncTableType": "router", - "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 - }, - "replicationBridgeTlsEnabled": { - "description": "Enable or disable use of encryption (TLS) for the replication Bridge connection. 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": "global/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 - }, - "replicationBridgeUnidirectionalClientProfileName": { - "description": "The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`.", - "maxLength": 32, - "minLength": 1, - "pattern": "^#?[A-Za-z0-9\\-_]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "#client-profile", - "x-configSyncTableType": "vpn", - "x-default": "#client-profile", - "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 - }, - "replicationEnabled": { - "description": "Enable or disable replication for the Message VPN. 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": "global/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 - }, - "replicationEnabledQueueBehavior": { - "description": "The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. 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 `\"fail-on-existing-queue\"`. The allowed values and their meaning are:\n\n
\n\"fail-on-existing-queue\" - The data replication queue must not already exist.\n\"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail.\n\"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications.\n
\n", - "enum": [ - "fail-on-existing-queue", - "force-use-existing-queue", - "force-recreate-queue" - ], - "type": "string", - "x-accessLevels": { - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "fail-on-existing-queue", - "x-configSyncTableType": "router", - "x-default": "fail-on-existing-queue", - "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": [ - "replicationEnabled" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "replicationQueueMaxMsgSpoolUsage": { - "description": "The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`.", - "format": "int64", - "maximum": 6000000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60000, - "x-configSyncTableType": "vpn", - "x-default": 60000, - "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 - }, - "replicationQueueRejectMsgToSenderOnDiscardEnabled": { - "description": "Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. 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 - }, - "replicationRejectMsgWhenSyncIneligibleEnabled": { - "description": "Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. 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 - }, - "replicationRole": { - "description": "The replication role for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"standby\"`. The allowed values and their meaning are:\n\n
\n\"active\" - Assume the Active role in replication for the Message VPN.\n\"standby\" - Assume the Standby role in replication for the Message VPN.\n
\n", - "enum": [ - "active", - "standby" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "standby", - "x-configSyncTableType": "router", - "x-default": "standby", - "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 - }, - "replicationTransactionMode": { - "description": "The transaction replication mode for all transactions within the Message VPN. Changing this value during operation will not affect existing transactions; it is only used upon starting a transaction. 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": "async", - "x-configSyncTableType": "vpn", - "x-default": "async", - "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 - }, - "restTlsServerCertEnforceTrustedCommonNameEnabled": { - "description": "Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": true, - "x-configSyncTableType": "vpn", - "x-default": false, - "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 - }, - "restTlsServerCertMaxChainDepth": { - "description": "The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 8, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "restTlsServerCertValidateDateEnabled": { - "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. 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": "global/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 - }, - "restTlsServerCertValidateNameEnabled": { - "description": "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote broker. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "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 - }, - "sempOverMsgBusAdminClientEnabled": { - "description": "Enable or disable \"admin client\" 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": "global/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 - }, - "sempOverMsgBusAdminDistributedCacheEnabled": { - "description": "Enable or disable \"admin distributed-cache\" 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": "global/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 - }, - "sempOverMsgBusAdminEnabled": { - "description": "Enable or disable \"admin\" 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": "global/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 - }, - "sempOverMsgBusEnabled": { - "description": "Enable or disable SEMP over the message bus for the current 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": "global/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 - }, - "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", - "patch": "global/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 - }, - "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": "global/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 - }, - "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, - "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.8.", - "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.8.", - "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.8.", - "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 - }, - "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, - "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.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", - "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 - }, - "serviceRestIncomingAuthorizationHeaderHandling": { - "description": "The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are:\n\n
\n\"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.\n\"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n\"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n
\n Available since 2.19.", - "enum": [ - "drop", - "forward", - "legacy" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "legacy", - "x-configSyncTableType": "vpn", - "x-default": "drop", - "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 - }, - "serviceRestIncomingMaxConnectionCount": { - "description": "The maximum number of REST incoming 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.", - "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 - }, - "serviceRestIncomingPlainTextEnabled": { - "description": "Enable or disable the plain-text REST service for incoming clients 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`.", - "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 - }, - "serviceRestIncomingPlainTextListenPort": { - "description": "The port number for incoming plain-text REST 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 serviceRestIncomingPlainTextEnabled 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`.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceRestIncomingPlainTextEnabled" - ], - "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 - }, - "serviceRestIncomingTlsEnabled": { - "description": "Enable or disable the use of encryption (TLS) for the REST service for incoming clients 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`.", - "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 - }, - "serviceRestIncomingTlsListenPort": { - "description": "The port number for incoming REST 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 serviceRestIncomingTlsEnabled 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`.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [ - "serviceRestIncomingTlsEnabled" - ], - "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 - }, - "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.8.", - "enum": [ - "gateway", - "messaging" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "messaging", - "x-configSyncTableType": "vpn", - "x-default": "messaging", - "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 - }, - "serviceRestOutgoingMaxConnectionCount": { - "description": "The maximum number of REST Consumer (outgoing) 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 varies by platform.", - "format": "int64", - "maximum": 6000, - "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 - }, - "serviceSmfMaxConnectionCount": { - "description": "The maximum number of SMF 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 varies by platform.", - "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 - }, - "serviceSmfPlainTextEnabled": { - "description": "Enable or disable the plain-text SMF 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 `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 - }, - "serviceSmfTlsEnabled": { - "description": "Enable or disable the use of encryption (TLS) for the SMF 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 `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 - }, - "serviceWebAuthenticationClientCertRequest": { - "description": "Determines when to request a client certificate from a Web Transport 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 - }, - "serviceWebMaxConnectionCount": { - "description": "The maximum number of Web Transport 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.", - "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 - }, - "serviceWebPlainTextEnabled": { - "description": "Enable or disable the plain-text Web Transport 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 `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 - }, - "serviceWebTlsEnabled": { - "description": "Enable or disable the use of TLS for the Web Transport 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 `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 - }, - "tlsAllowDowngradeToPlainTextEnabled": { - "description": "Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. 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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "MsgVpnAclProfile": { - "properties": { - "aclProfileName": { - "description": "The name of the ACL Profile.", - "maxLength": 32, - "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 - }, - "clientConnectDefaultAction": { - "description": "The default action to take when a client using the ACL Profile connects to the Message VPN. 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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "disallow", - "x-configSyncTableType": "vpn", - "x-default": "disallow", - "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 - }, - "publishTopicDefaultAction": { - "description": "The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. 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 topic unless an exception is found for it.\n\"disallow\" - Disallow topic unless an exception is found for it.\n
\n", - "enum": [ - "allow", - "disallow" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "disallow", - "x-configSyncTableType": "vpn", - "x-default": "disallow", - "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 - }, - "subscribeShareNameDefaultAction": { - "description": "The default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow\"`. The allowed values and their meaning are:\n\n
\n\"allow\" - Allow topic unless an exception is found for it.\n\"disallow\" - Disallow topic unless an exception is found for it.\n
\n Available since 2.14.", - "enum": [ - "allow", - "disallow" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "allow", - "x-configSyncTableType": "vpn", - "x-default": "allow", - "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 - }, - "subscribeTopicDefaultAction": { - "description": "The default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. 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 topic unless an exception is found for it.\n\"disallow\" - Disallow topic unless an exception is found for it.\n
\n", - "enum": [ - "allow", - "disallow" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "disallow", - "x-configSyncTableType": "vpn", - "x-default": "disallow", - "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" - }, - "MsgVpnAclProfileClientConnectException": { - "properties": { - "aclProfileName": { - "description": "The name of the ACL Profile.", - "maxLength": 32, - "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 - }, - "clientConnectExceptionAddress": { - "description": "The IP address/netmask of the client connect exception in canonical 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" - }, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnAclProfileClientConnectExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Client Connect Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAclProfileClientConnectExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" - }, - "links": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileClientConnectExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileLinks": { - "properties": { - "clientConnectExceptionsUri": { - "description": "The URI of this ACL Profile's collection of Client Connect Exception objects.", - "type": "string" - }, - "publishExceptionsUri": { - "description": "The URI of this ACL Profile's collection of Publish Topic Exception objects. Deprecated since 2.14. Replaced by publishTopicExceptions.", - "type": "string" - }, - "publishTopicExceptionsUri": { - "description": "The URI of this ACL Profile's collection of Publish Topic Exception objects. Available since 2.14.", - "type": "string" - }, - "subscribeExceptionsUri": { - "description": "The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "type": "string" - }, - "subscribeShareNameExceptionsUri": { - "description": "The URI of this ACL Profile's collection of Subscribe Share Name Exception objects. Available since 2.14.", - "type": "string" - }, - "subscribeTopicExceptionsUri": { - "description": "The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Available since 2.14.", - "type": "string" - }, - "uri": { - "description": "The URI of this ACL Profile object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAclProfilePublishException": { - "properties": { - "aclProfileName": { - "description": "The name of the ACL Profile. Deprecated since 2.14. Replaced by publishTopicExceptions.", - "maxLength": 32, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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. Deprecated since 2.14. Replaced by publishTopicExceptions.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "publishExceptionTopic": { - "description": "The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by publishTopicExceptions.", - "maxLength": 250, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "topicSyntax": { - "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n Deprecated since 2.14. Replaced by publishTopicExceptions.", - "enum": [ - "smf", - "mqtt" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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" - }, - "MsgVpnAclProfilePublishExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Publish Topic Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAclProfilePublishExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAclProfilePublishException" - }, - "links": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfilePublishExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfilePublishException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfilePublishTopicException": { - "properties": { - "aclProfileName": { - "description": "The name of the ACL Profile.", - "maxLength": 32, - "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 - }, - "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 - }, - "publishTopicException": { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "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 - }, - "publishTopicExceptionSyntax": { - "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n", - "enum": [ - "smf", - "mqtt" - ], - "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" - }, - "MsgVpnAclProfilePublishTopicExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Publish Topic Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAclProfilePublishTopicExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" - }, - "links": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfilePublishTopicExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAclProfile" - }, - "links": { - "$ref": "#/definitions/MsgVpnAclProfileLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileSubscribeException": { - "properties": { - "aclProfileName": { - "description": "The name of the ACL Profile. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "maxLength": 32, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "subscribeExceptionTopic": { - "description": "The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "maxLength": 250, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "topicSyntax": { - "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n Deprecated since 2.14. Replaced by subscribeTopicExceptions.", - "enum": [ - "smf", - "mqtt" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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" - }, - "MsgVpnAclProfileSubscribeExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Subscribe Topic Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAclProfileSubscribeExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" - }, - "links": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileSubscribeExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileSubscribeShareNameException": { - "properties": { - "aclProfileName": { - "description": "The name of the ACL Profile.", - "maxLength": 32, - "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 - }, - "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 - }, - "subscribeShareNameException": { - "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", - "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 - }, - "subscribeShareNameExceptionSyntax": { - "description": "The syntax of the subscribe share name for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n", - "enum": [ - "smf", - "mqtt" - ], - "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" - }, - "MsgVpnAclProfileSubscribeShareNameExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Subscribe Share Name Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAclProfileSubscribeShareNameExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" - }, - "links": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileSubscribeShareNameExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileSubscribeTopicException": { - "properties": { - "aclProfileName": { - "description": "The name of the ACL Profile.", - "maxLength": 32, - "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 - }, - "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 - }, - "subscribeTopicException": { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "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 - }, - "subscribeTopicExceptionSyntax": { - "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n", - "enum": [ - "smf", - "mqtt" - ], - "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" - }, - "MsgVpnAclProfileSubscribeTopicExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Subscribe Topic Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAclProfileSubscribeTopicExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" - }, - "links": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfileSubscribeTopicExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAclProfilesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfile" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAclProfileLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProfile": { - "properties": { - "authorizationGroupsClaimName": { - "description": "The name of the groups claim. If non-empty, the specified claim will be used to determine groups for authorization. If empty, the authorizationType attribute of the Message VPN will be used to determine authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"groups\"`.", - "maxLength": 100, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "groups", - "x-configSyncTableType": "vpn", - "x-default": "groups", - "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 - }, - "authorizationGroupsClaimStringFormat": { - "description": "The format of the authorization groups claim value when it is a string. Changes to this attribute are synchronized to HA mates and replication sites 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" - }, - "x-autoDisable": [], - "x-configSyncDefault": "single", - "x-configSyncTableType": "vpn", - "x-default": "single", - "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 - }, - "clientId": { - "description": "The OAuth client id. 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 - }, - "clientRequiredType": { - "description": "The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"JWT\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "JWT", - "x-configSyncTableType": "vpn", - "x-default": "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 - }, - "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 and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 512, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "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-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 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 - }, - "disconnectOnTokenExpirationEnabled": { - "description": "Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. 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 - }, - "enabled": { - "description": "Enable or disable the OAuth profile. 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 - }, - "endpointDiscovery": { - "description": "The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. 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": [], - "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 - }, - "endpointDiscoveryRefreshInterval": { - "description": "The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites 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" - }, - "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "vpn", - "x-default": 86400, - "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 - }, - "endpointIntrospection": { - "description": "The OAuth introspection endpoint. 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": [], - "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 - }, - "endpointIntrospectionTimeout": { - "description": "The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites 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" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "endpointJwks": { - "description": "The OAuth JWKS endpoint. 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": [], - "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 - }, - "endpointJwksRefreshInterval": { - "description": "The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites 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" - }, - "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "vpn", - "x-default": 86400, - "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 - }, - "endpointUserinfo": { - "description": "The OpenID Connect Userinfo endpoint. 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": [], - "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 - }, - "endpointUserinfoTimeout": { - "description": "The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites 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" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "issuer": { - "description": "The Issuer Identifier for the OAuth provider. 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": [], - "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 - }, - "mqttUsernameValidateEnabled": { - "description": "Enable or disable whether the API provided MQTT client username will be validated against the username calculated from the token(s). When enabled, connection attempts by MQTT clients are rejected if they differ. Note that this value only applies to MQTT clients; SMF client usernames will not be validated. 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 - }, - "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 - }, - "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" - }, - "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 - }, - "oauthRole": { - "description": "The OAuth role of the broker. Changes to this attribute are synchronized to HA mates and replication sites 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" - }, - "x-autoDisable": [], - "x-configSyncDefault": "client", - "x-configSyncTableType": "vpn", - "x-default": "client", - "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 - }, - "resourceServerParseAccessTokenEnabled": { - "description": "Enable or disable parsing of the access token as a JWT. 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 - }, - "resourceServerRequiredAudience": { - "description": "The required audience value. 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 - }, - "resourceServerRequiredIssuer": { - "description": "The required issuer value. 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": [], - "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 - }, - "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 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 - }, - "resourceServerRequiredType": { - "description": "The required TYP value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"at+jwt\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "at+jwt", - "x-configSyncTableType": "vpn", - "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 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 - }, - "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 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 - }, - "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 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 - }, - "resourceServerValidateTypeEnabled": { - "description": "Enable or disable verification of the TYP field in the access token header. 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 - }, - "usernameClaimName": { - "description": "The name of the username claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`.", - "maxLength": 100, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "sub", - "x-configSyncTableType": "vpn", - "x-default": "sub", - "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" - }, - "MsgVpnAuthenticationOauthProfileClientRequiredClaim": { - "properties": { - "clientRequiredClaimName": { - "description": "The name of the ID token claim to verify.", - "maxLength": 100, - "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 - }, - "clientRequiredClaimValue": { - "description": "The required claim value.", - "maxLength": 200, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/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 - }, - "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 - }, - "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" - }, - "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": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks": { - "properties": { - "uri": { - "description": "The URI of this Required Claim object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" - }, - "links": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProfileLinks": { - "properties": { - "clientRequiredClaimsUri": { - "description": "The URI of this OAuth Profile's collection of Required Claim 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" - }, - "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim": { - "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 - }, - "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" - }, - "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": "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 - }, - "resourceServerRequiredClaimValue": { - "description": "The required claim value.", - "maxLength": 200, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/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": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks": { - "properties": { - "uri": { - "description": "The URI of this Required Claim object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" - }, - "links": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProfileResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" - }, - "links": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProfilesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProvider": { - "properties": { - "audienceClaimName": { - "description": "The audience claim name, indicating which part of the object to use for determining the audience. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"aud\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 32, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "aud", - "x-configSyncTableType": "vpn", - "x-default": "aud", - "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 - }, - "audienceClaimSource": { - "description": "The audience claim source, indicating where to search for the audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are:\n\n
\n\"access-token\" - The OAuth v2 access_token.\n\"id-token\" - The OpenID Connect id_token.\n\"introspection\" - The result of introspecting the OAuth v2 access_token.\n
\n Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "enum": [ - "access-token", - "id-token", - "introspection" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "id-token", - "x-configSyncTableType": "vpn", - "x-default": "id-token", - "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 - }, - "audienceClaimValue": { - "description": "The required audience value for a token to be considered valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 64, - "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": 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 - }, - "audienceValidationEnabled": { - "description": "Enable or disable audience validation. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "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": 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 - }, - "authorizationGroupClaimName": { - "description": "The authorization group claim name, indicating which part of the object to use for determining the authorization group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"scope\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 32, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "scope", - "x-configSyncTableType": "vpn", - "x-default": "scope", - "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 - }, - "authorizationGroupClaimSource": { - "description": "The authorization group claim source, indicating where to search for the authorization group name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are:\n\n
\n\"access-token\" - The OAuth v2 access_token.\n\"id-token\" - The OpenID Connect id_token.\n\"introspection\" - The result of introspecting the OAuth v2 access_token.\n
\n Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "enum": [ - "access-token", - "id-token", - "introspection" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "id-token", - "x-configSyncTableType": "vpn", - "x-default": "id-token", - "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 - }, - "authorizationGroupEnabled": { - "description": "Enable or disable OAuth based authorization. When enabled, the configured authorization type for OAuth clients is overridden. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "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": 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 - }, - "disconnectOnTokenExpirationEnabled": { - "description": "Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "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": 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 - }, - "enabled": { - "description": "Enable or disable OAuth Provider client authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "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": 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 - }, - "jwksRefreshInterval": { - "description": "The number of seconds between forced JWKS public key refreshing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "format": "int32", - "maximum": 31536000, - "minimum": 60, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "vpn", - "x-default": 86400, - "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 - }, - "jwksUri": { - "description": "The URI where the OAuth provider publishes its JWKS public keys. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 2048, - "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": 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 - }, - "msgVpnName": { - "description": "The name of the Message VPN. Deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "oauthProviderName": { - "description": "The name of the OAuth Provider. Deprecated since 2.25. Replaced by authenticationOauthProfiles.", - "maxLength": 31, - "minLength": 1, - "pattern": "^[^~]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "tokenIgnoreTimeLimitsEnabled": { - "description": "Enable or disable whether to ignore time limits and accept tokens that are not yet valid or are no longer valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "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": 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 - }, - "tokenIntrospectionParameterName": { - "description": "The parameter name used to identify the token during access token introspection. A standards compliant OAuth introspection server expects \"token\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"token\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 32, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "token", - "x-configSyncTableType": "vpn", - "x-default": "token", - "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 - }, - "tokenIntrospectionPassword": { - "description": "The password to use when logging into the token introspection URI. 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 `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 64, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": true, - "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 - }, - "tokenIntrospectionTimeout": { - "description": "The maximum time in seconds a token introspection is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "format": "int32", - "maximum": 60, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "x-default": 1, - "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 - }, - "tokenIntrospectionUri": { - "description": "The token introspection URI of the OAuth authentication server. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 2048, - "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": 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 - }, - "tokenIntrospectionUsername": { - "description": "The username to use when logging into the token introspection URI. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 32, - "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": 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 - }, - "usernameClaimName": { - "description": "The username claim name, indicating which part of the object to use for determining the username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "maxLength": 64, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "sub", - "x-configSyncTableType": "vpn", - "x-default": "sub", - "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 - }, - "usernameClaimSource": { - "description": "The username claim source, indicating where to search for the username value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are:\n\n
\n\"access-token\" - The OAuth v2 access_token.\n\"id-token\" - The OpenID Connect id_token.\n\"introspection\" - The result of introspecting the OAuth v2 access_token.\n
\n Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "enum": [ - "access-token", - "id-token", - "introspection" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "id-token", - "x-configSyncTableType": "vpn", - "x-default": "id-token", - "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 - }, - "usernameValidateEnabled": { - "description": "Enable or disable whether the API provided username will be validated against the username calculated from the token(s); the connection attempt is rejected if they differ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", - "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": 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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnAuthenticationOauthProviderLinks": { - "properties": { - "uri": { - "description": "The URI of this OAuth Provider object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAuthenticationOauthProviderResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" - }, - "links": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthenticationOauthProvidersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthorizationGroup": { - "properties": { - "aclProfileName": { - "description": "The ACL Profile of the Authorization 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 `\"default\"`.", - "maxLength": 32, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "default", - "x-configSyncTableType": "vpn", - "x-default": "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 - }, - "authorizationGroupName": { - "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'.", - "maxLength": 256, - "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 - }, - "clientProfileName": { - "description": "The Client Profile of the Authorization 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 `\"default\"`.", - "maxLength": 32, - "minLength": 1, - "pattern": "^#?[A-Za-z0-9\\-_]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "default", - "x-configSyncTableType": "vpn", - "x-default": "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 - }, - "enabled": { - "description": "Enable or disable the Authorization Group in the 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 - }, - "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 - }, - "orderAfterAuthorizationGroupName": { - "description": "Lower the priority to be less than this group. 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 is not applicable.", - "maxLength": 256, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "orderBeforeAuthorizationGroupName" - ], - "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-requiresDisable": [], - "x-writeOnly": true - }, - "orderBeforeAuthorizationGroupName": { - "description": "Raise the priority to be greater than this group. 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 is not applicable.", - "maxLength": 256, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncTableType": "vpn", - "x-conflicts": [ - "orderAfterAuthorizationGroupName" - ], - "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-requiresDisable": [], - "x-writeOnly": true - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnAuthorizationGroupLinks": { - "properties": { - "uri": { - "description": "The URI of this Authorization Group object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnAuthorizationGroupResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" - }, - "links": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnAuthorizationGroupsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridge": { - "properties": { - "bridgeName": { - "description": "The name of the Bridge.", - "maxLength": 150, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "bridgeVirtualRouter": { - "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge 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": 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 the Bridge. 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 - }, - "maxTtl": { - "description": "The maximum time-to-live (TTL) in hops. Messages are discarded if their TTL exceeds this value. 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 `8`.", - "format": "int64", - "maximum": 255, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 8, - "x-configSyncTableType": "vpn", - "x-default": 8, - "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 - }, - "remoteAuthenticationBasicClientUsername": { - "description": "The Client Username the Bridge uses to login to the remote Message VPN. 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, - "pattern": "^[^?*]*$", - "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-requires": [ - "remoteAuthenticationBasicPassword" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "remoteAuthenticationBasicPassword": { - "description": "The password for the Client 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": { - "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": [ - "remoteAuthenticationBasicClientUsername" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "remoteAuthenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. 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": { - "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 - }, - "remoteAuthenticationClientCertPassword": { - "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": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", - "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": [ - "remoteAuthenticationClientCertContent" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "remoteAuthenticationScheme": { - "description": "The authentication scheme for the remote Message VPN. 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 `\"basic\"`. The allowed values and their meaning are:\n\n
\n\"basic\" - Basic Authentication Scheme (via username and password).\n\"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content).\n
\n", - "enum": [ - "basic", - "client-certificate" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "basic", - "x-configSyncTableType": "vpn", - "x-default": "basic", - "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 - }, - "remoteConnectionRetryCount": { - "description": "The maximum number of retry attempts to establish a connection to the remote Message VPN. 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 - }, - "remoteConnectionRetryDelay": { - "description": "The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 255, - "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, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "remoteDeliverToOnePriority": { - "description": "The priority for deliver-to-one (DTO) messages transmitted from the remote Message VPN. 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 `\"p1\"`. The allowed values and their meaning are:\n\n
\n\"p1\" - The 1st or highest priority.\n\"p2\" - The 2nd highest priority.\n\"p3\" - The 3rd highest priority.\n\"p4\" - The 4th highest priority.\n\"da\" - Ignore priority and deliver always.\n
\n", - "enum": [ - "p1", - "p2", - "p3", - "p4", - "da" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "p1", - "x-configSyncTableType": "vpn", - "x-default": "p1", - "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 - }, - "tlsCipherSuiteList": { - "description": "The colon-separated list of cipher suites supported for TLS connections to the remote Message VPN. The value \"default\" implies all supported suites ordered from most secure to least secure. 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": [], - "x-configSyncDefault": "default", - "x-configSyncTableType": "vpn", - "x-default": "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": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnBridgeLinks": { - "properties": { - "remoteMsgVpnsUri": { - "description": "The URI of this Bridge's collection of Remote Message VPN objects.", - "type": "string" - }, - "remoteSubscriptionsUri": { - "description": "The URI of this Bridge's collection of Remote Subscription objects.", - "type": "string" - }, - "tlsTrustedCommonNamesUri": { - "description": "The URI of this Bridge's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "type": "string" - }, - "uri": { - "description": "The URI of this Bridge object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnBridgeRemoteMsgVpn": { - "properties": { - "bridgeName": { - "description": "The name of the Bridge.", - "maxLength": 150, - "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 - }, - "bridgeVirtualRouter": { - "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge 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 - }, - "clientUsername": { - "description": "The Client Username the Bridge uses to login to the remote Message VPN. This per remote Message VPN value overrides the value provided for the Bridge overall. 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, - "pattern": "^[^?*]*$", - "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-requires": [ - "password" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "compressedDataEnabled": { - "description": "Enable or disable data compression for the remote Message VPN connection. 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" - }, - "x-autoDisable": [ - "enabled" - ], - "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 - }, - "connectOrder": { - "description": "The preference given to incoming connections from remote Message VPN hosts, from 1 (highest priority) to 4 (lowest priority). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 4, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "vpn", - "x-default": 4, - "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 - }, - "egressFlowWindowSize": { - "description": "The number of outstanding guaranteed messages that can be transmitted over the remote Message VPN connection before an acknowledgment is received. 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 `255`.", - "format": "int64", - "maximum": 65535, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 255, - "x-configSyncTableType": "vpn", - "x-default": 255, - "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 - }, - "enabled": { - "description": "Enable or disable the remote 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 - }, - "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 - }, - "password": { - "description": "The password for the Client 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": { - "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": [ - "clientUsername" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "queueBinding": { - "description": "The queue binding of the Bridge in the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, - "pattern": "^[^*?'<>&;]*$", - "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 - }, - "remoteMsgVpnInterface": { - "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.", - "maxLength": 15, - "minLength": 0, - "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": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "remoteMsgVpnLocation": { - "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:\").", - "maxLength": 259, - "minLength": 1, - "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}))|(v:.+))$", - "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 - }, - "remoteMsgVpnName": { - "description": "The name of the remote 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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "tlsEnabled": { - "description": "Enable or disable encryption (TLS) for the remote Message VPN connection. 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" - }, - "x-autoDisable": [ - "enabled" - ], - "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 - }, - "unidirectionalClientProfile": { - "description": "The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2 MB. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`.", - "maxLength": 32, - "minLength": 1, - "pattern": "^#?[A-Za-z0-9\\-_]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "#client-profile", - "x-configSyncTableType": "vpn", - "x-default": "#client-profile", - "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" - }, - "MsgVpnBridgeRemoteMsgVpnLinks": { - "properties": { - "uri": { - "description": "The URI of this Remote Message VPN object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnBridgeRemoteMsgVpnResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" - }, - "links": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridgeRemoteMsgVpnsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridgeRemoteSubscription": { - "properties": { - "bridgeName": { - "description": "The name of the Bridge.", - "maxLength": 150, - "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 - }, - "bridgeVirtualRouter": { - "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge 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 - }, - "deliverAlwaysEnabled": { - "description": "Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/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 - }, - "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 - }, - "remoteSubscriptionTopic": { - "description": "The topic of the Bridge remote 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" - }, - "MsgVpnBridgeRemoteSubscriptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Remote Subscription object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnBridgeRemoteSubscriptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" - }, - "links": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridgeRemoteSubscriptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridgeResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnBridge" - }, - "links": { - "$ref": "#/definitions/MsgVpnBridgeLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridgeTlsTrustedCommonName": { - "properties": { - "bridgeName": { - "description": "The name of the Bridge. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 150, - "minLength": 1, - "pattern": "^[A-Za-z0-9\"~`!\\\\@$%|\\^()_+={}:,.#\\-;\\[\\]]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "bridgeVirtualRouter": { - "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "enum": [ - "primary", - "backup", - "auto" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "tlsTrustedCommonName": { - "description": "The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", - "maxLength": 64, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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" - }, - "MsgVpnBridgeTlsTrustedCommonNameLinks": { - "properties": { - "uri": { - "description": "The URI of this Trusted Common Name object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnBridgeTlsTrustedCommonNameResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" - }, - "links": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridgeTlsTrustedCommonNamesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnBridgesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnBridge" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnBridgeLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnCertMatchingRule": { - "properties": { - "enabled": { - "description": "Enable or disable a certificate matching rule. 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": "global/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 - }, - "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 - }, - "ruleName": { - "description": "The name of the rule.", - "maxLength": 64, - "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": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnCertMatchingRuleAttributeFilter": { - "properties": { - "attributeName": { - "description": "Client Username Attribute to be tested. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, - "pattern": "^([A-Za-z][A-Za-z0-9\\-]*)?$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "attributeValue": { - "description": "Expected attribute value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 256, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "filterName": { - "description": "The name of the filter.", - "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 - }, - "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 - }, - "ruleName": { - "description": "The name of the rule.", - "maxLength": 64, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnCertMatchingRuleAttributeFilterLinks": { - "properties": { - "uri": { - "description": "The URI of this Certificate Matching Rule Attribute Filter object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnCertMatchingRuleAttributeFilterResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" - }, - "links": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnCertMatchingRuleAttributeFiltersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnCertMatchingRuleCondition": { - "properties": { - "attribute": { - "description": "Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`.", - "maxLength": 64, - "minLength": 0, - "pattern": "^([A-Za-z][A-Za-z0-9\\-]*)?$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "expression": { - "description": "Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`.", - "maxLength": 256, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "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 - }, - "ruleName": { - "description": "The name of the rule.", - "maxLength": 64, - "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 - }, - "source": { - "description": "Certificate field to be compared with the Attribute. The allowed values and their meaning are:\n\n
\n\"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.\n\"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.\n\"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.\n\"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.\n\"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.\n\"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.\n\"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN.\n\"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN.\n\"issuer\" - The attribute is extracted from the certificate's Issuer DN.\n\"subject\" - The attribute is extracted from the certificate's Subject DN.\n\"serial-number\" - The attribute is extracted from the certificate's Serial Number.\n\"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNS Name.\n\"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IP Address.\n
\n", - "enum": [ - "certificate-thumbprint", - "common-name", - "common-name-last", - "subject-alternate-name-msupn", - "uid", - "uid-last", - "org-unit", - "org-unit-last", - "issuer", - "subject", - "serial-number", - "dns-name", - "ip-address" - ], - "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": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnCertMatchingRuleConditionLinks": { - "properties": { - "uri": { - "description": "The URI of this Certificate Matching Rule Condition object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnCertMatchingRuleConditionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleCondition" - }, - "links": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnCertMatchingRuleConditionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleCondition" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnCertMatchingRuleLinks": { - "properties": { - "attributeFiltersUri": { - "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects. Available since 2.28.", - "type": "string" - }, - "conditionsUri": { - "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Certificate Matching Rule object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnCertMatchingRuleResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" - }, - "links": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnCertMatchingRulesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnClientProfile": { - "properties": { - "allowBridgeConnectionsEnabled": { - "description": "Enable or disable allowing Bridge clients using the Client Profile to connect. Changing this setting does not affect existing Bridge client connections. 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": "global/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 - }, - "allowCutThroughForwardingEnabled": { - "description": "Enable or disable allowing clients using the Client Profile to bind to endpoints with the cut-through forwarding delivery mode. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.22. This attribute has been deprecated. Please visit the Solace Product Lifecycle Policy web page for details on deprecated features.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": false, - "x-configSyncTableType": "vpn", - "x-default": false, - "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 - }, - "allowGuaranteedEndpointCreateDurability": { - "description": "The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. 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\"all\" - Client can create any type of endpoint.\n\"durable\" - Client can create only durable endpoints.\n\"non-durable\" - Client can create only non-durable endpoints.\n
\n Available since 2.14.", - "enum": [ - "all", - "durable", - "non-durable" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "all", - "x-configSyncTableType": "vpn", - "x-default": "all", - "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 - }, - "allowGuaranteedEndpointCreateEnabled": { - "description": "Enable or disable allowing clients using the Client Profile to create topic endpoints or queues. Changing this value does not affect existing client connections. 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": "global/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 - }, - "allowGuaranteedMsgReceiveEnabled": { - "description": "Enable or disable allowing clients using the Client Profile to receive guaranteed messages. Changing this setting does not affect existing client connections. 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": "global/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 - }, - "allowGuaranteedMsgSendEnabled": { - "description": "Enable or disable allowing clients using the Client Profile to send guaranteed messages. Changing this setting does not affect existing client connections. 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": "global/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 - }, - "allowSharedSubscriptionsEnabled": { - "description": "Enable or disable allowing shared subscriptions. Changing this setting does not affect existing subscriptions. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "allowTransactedSessionsEnabled": { - "description": "Enable or disable allowing clients using the Client Profile to establish transacted sessions. Changing this setting does not affect existing client connections. 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": "global/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 - }, - "apiQueueManagementCopyFromOnCreateName": { - "description": "The name of a queue to copy settings from when a new queue is created by a client using the Client Profile. The referenced queue must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiQueueManagementCopyFromOnCreateTemplateName`.", - "maxLength": 200, - "minLength": 0, - "pattern": "^[^*?'<>&;]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "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 - }, - "apiQueueManagementCopyFromOnCreateTemplateName": { - "description": "The name of a queue template to copy settings from when a new queue is created by a client using the Client Profile. If the referenced queue template does not exist, queue creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", - "maxLength": 255, - "minLength": 0, - "pattern": "^[^#?*]?[^?*]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "apiTopicEndpointManagementCopyFromOnCreateName": { - "description": "The name of a topic endpoint to copy settings from when a new topic endpoint is created by a client using the Client Profile. The referenced topic endpoint must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiTopicEndpointManagementCopyFromOnCreateTemplateName`.", - "maxLength": 200, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "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 - }, - "apiTopicEndpointManagementCopyFromOnCreateTemplateName": { - "description": "The name of a topic endpoint template to copy settings from when a new topic endpoint is created by a client using the Client Profile. If the referenced topic endpoint template does not exist, topic endpoint creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", - "maxLength": 255, - "minLength": 0, - "pattern": "^[^#?*]?[^?*]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "clientProfileName": { - "description": "The name of the Client Profile.", - "maxLength": 32, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "compressionEnabled": { - "description": "Enable or disable allowing clients using the Client Profile to use compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.10.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "elidingDelay": { - "description": "The amount of time to delay the delivery of messages to clients using the Client Profile after the initial message has been delivered (the eliding delay interval), in milliseconds. A value of 0 means there is no delay in delivering messages to clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", - "format": "int64", - "maximum": 60000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "elidingEnabled": { - "description": "Enable or disable message eliding for clients using the Client Profile. 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": "global/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 - }, - "elidingMaxTopicCount": { - "description": "The maximum number of topics tracked for message eliding per client connection using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`.", - "format": "int64", - "maximum": 32000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "eventClientProvisionedEndpointSpoolUsageThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold" - }, - "eventConnectionCountPerClientUsernameThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold" - }, - "eventEgressFlowCountThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventEgressFlowCountThreshold" - }, - "eventEndpointCountPerClientUsernameThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold" - }, - "eventIngressFlowCountThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventIngressFlowCountThreshold" - }, - "eventServiceSmfConnectionCountPerClientUsernameThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold" - }, - "eventServiceWebConnectionCountPerClientUsernameThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold" - }, - "eventSubscriptionCountThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventSubscriptionCountThreshold" - }, - "eventTransactedSessionCountThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventTransactedSessionCountThreshold" - }, - "eventTransactionCountThreshold": { - "$ref": "#/definitions/MsgVpnClientProfileEventTransactionCountThreshold" - }, - "maxConnectionCountPerClientUsername": { - "description": "The maximum number of client connections per Client Username using the Client Profile. 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": "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 - }, - "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 `16000`.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 16000, - "x-configSyncTableType": "vpn", - "x-default": 16000, - "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 - }, - "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 `16000`.", - "format": "int64", - "maximum": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 16000, - "x-configSyncTableType": "vpn", - "x-default": 16000, - "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 - }, - "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 `16000`.", - "format": "int64", - "maximum": 1000000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 16000, - "x-configSyncTableType": "vpn", - "x-default": 16000, - "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 - }, - "maxMsgsPerTransaction": { - "description": "The maximum number of publisher and consumer messages combined that is allowed within a transaction for each client associated with this client-profile. Exceeding this limit will result in a transaction prepare or commit failure. Changing this value during operation will not affect existing sessions. It is only validated at transaction creation time. Large transactions consume more resources and are more likely to require retrieving messages from the ADB or from disk to process the transaction prepare or commit requests. The transaction processing rate may diminish if a large number of messages must be retrieved from the ADB or from disk. Care should be taken to not use excessively large transactions needlessly to avoid exceeding resource limits and to avoid reducing the overall broker performance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. Available since 2.20.", - "format": "int32", - "maximum": 20000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "maxSubscriptionCount": { - "description": "The maximum number of subscriptions per client using the Client Profile. This limit is not enforced when a client adds a subscription to an endpoint, except for MQTT QoS 1 subscriptions. In addition, this limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", - "format": "int64", - "maximum": 4294967295, - "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 - }, - "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": 100000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 10, - "x-configSyncTableType": "vpn", - "x-default": 10, - "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 - }, - "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": 100000, - "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 - }, - "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 - }, - "queueControl1MaxDepth": { - "description": "The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "vpn", - "x-default": 20000, - "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 - }, - "queueControl1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `queueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "vpn", - "x-default": 4, - "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 - }, - "queueDirect1MaxDepth": { - "description": "The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "vpn", - "x-default": 20000, - "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 - }, - "queueDirect1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `queueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "vpn", - "x-default": 4, - "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 - }, - "queueDirect2MaxDepth": { - "description": "The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "vpn", - "x-default": 20000, - "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 - }, - "queueDirect2MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `queueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "vpn", - "x-default": 4, - "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 - }, - "queueDirect3MaxDepth": { - "description": "The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "vpn", - "x-default": 20000, - "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 - }, - "queueDirect3MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `queueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4, - "x-configSyncTableType": "vpn", - "x-default": 4, - "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 - }, - "queueGuaranteed1MaxDepth": { - "description": "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", - "format": "int32", - "maximum": 262144, - "minimum": 2, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 20000, - "x-configSyncTableType": "vpn", - "x-default": 20000, - "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 - }, - "queueGuaranteed1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-1) priority queue, regardless of the `queueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", - "format": "int32", - "maximum": 262144, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 255, - "x-configSyncTableType": "vpn", - "x-default": 255, - "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 - }, - "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`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "replicationAllowClientConnectWhenStandbyEnabled": { - "description": "Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. 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": "global/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 - }, - "serviceMinKeepaliveTimeout": { - "description": "The minimum client keepalive timeout which will be enforced for client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. Available since 2.19.", - "format": "int32", - "maximum": 3600, - "minimum": 3, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "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 - }, - "serviceSmfMaxConnectionCountPerClientUsername": { - "description": "The maximum number of SMF client connections per Client Username using the Client Profile. 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": "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 - }, - "serviceSmfMinKeepaliveEnabled": { - "description": "Enable or disable the enforcement of a minimum keepalive timeout for SMF clients. 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": "global/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 - }, - "serviceWebInactiveTimeout": { - "description": "The timeout for inactive Web Transport client sessions using the Client Profile, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "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 - }, - "serviceWebMaxConnectionCountPerClientUsername": { - "description": "The maximum number of Web Transport client connections per Client Username using the Client Profile. 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": "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 - }, - "serviceWebMaxPayload": { - "description": "The maximum Web Transport payload size before fragmentation occurs for clients using the Client Profile, in bytes. The size of the header is not included. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", - "format": "int64", - "maximum": 10000000, - "minimum": 300, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1000000, - "x-configSyncTableType": "vpn", - "x-default": 1000000, - "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 - }, - "tcpCongestionWindowSize": { - "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": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 2, - "x-configSyncTableType": "vpn", - "x-default": 2, - "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 - }, - "tcpKeepaliveCount": { - "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": "global/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 - }, - "tcpKeepaliveIdleTime": { - "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": "global/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 - }, - "tcpKeepaliveInterval": { - "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", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "tcpMaxSegmentSize": { - "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", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1460, - "x-configSyncTableType": "vpn", - "x-default": 1460, - "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 - }, - "tcpMaxWindowSize": { - "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", - "patch": "global/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": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "tlsAllowDowngradeToPlainTextEnabled": { - "description": "Enable or disable allowing a client using the Client Profile to downgrade an encrypted connection to plain text. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.8.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold": { - "description": "The thresholds for the message spool usage event of Queues and Topic Endpoints provisioned by clients, relative to `maxMsgSpoolUsage` for these Queues and Topic Endpoints. Changing these values during operation does not affect existing sessions. For provisioned durable Queues and Topic Endpoints, this value applies when initially provisioned, but can then be changed afterwards by configuring the Queue or Topic Endpoint.", - "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.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "x-default": 18, - "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-requires": [ - "setPercent" - ], - "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.", - "format": "int64", - "maximum": 100, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80, - "x-configSyncTableType": "vpn", - "x-default": 25, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold": { - "description": "The thresholds for the Client Username connection count event of the Client Profile, relative to `maxConnectionCountPerClientUsername`.", - "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": "global/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": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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": "global/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": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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" - }, - "MsgVpnClientProfileEventEgressFlowCountThreshold": { - "description": "The thresholds for the transmit flow count event of the Client Profile, relative to `maxEgressFlowCount`.", - "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": "global/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": "global/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": "global/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": "global/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" - }, - "MsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold": { - "description": "The thresholds for the Client Username endpoint count event of the Client Profile, relative to `maxEndpointCountPerClientUsername`.", - "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": "global/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": "global/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": "global/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": "global/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" - }, - "MsgVpnClientProfileEventIngressFlowCountThreshold": { - "description": "The thresholds for the receive flow count event of the Client Profile, relative to `maxIngressFlowCount`.", - "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": "global/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": "global/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": "global/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": "global/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" - }, - "MsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold": { - "description": "The thresholds for the client username SMF connection count event of the Client Profile, relative to `serviceSmfMaxConnectionCountPerClientUsername`.", - "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": "global/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": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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": "global/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": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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" - }, - "MsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold": { - "description": "The thresholds for the Client Username Web Transport connection count event of the Client Profile, relative to `serviceWebMaxConnectionCountPerClientUsername`.", - "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": "global/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": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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": "global/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": 200000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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" - }, - "MsgVpnClientProfileEventSubscriptionCountThreshold": { - "description": "The thresholds for the subscription count event of the Client Profile, relative to `maxSubscriptionCount`.", - "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": "global/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": "global/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": "global/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": "global/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" - }, - "MsgVpnClientProfileEventTransactedSessionCountThreshold": { - "description": "The thresholds for the transacted session count event of the Client Profile, relative to `maxTransactedSessionCount`.", - "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": "global/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": "global/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": "global/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": "global/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" - }, - "MsgVpnClientProfileEventTransactionCountThreshold": { - "description": "The thresholds for the transaction count event of the Client Profile, relative to `maxTransactionCount`.", - "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": "global/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": "global/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": "global/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": "global/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" - }, - "MsgVpnClientProfileLinks": { - "properties": { - "uri": { - "description": "The URI of this Client Profile object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnClientProfileResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnClientProfile" - }, - "links": { - "$ref": "#/definitions/MsgVpnClientProfileLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnClientProfilesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnClientProfile" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnClientProfileLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnClientUsername": { - "properties": { - "aclProfileName": { - "description": "The ACL Profile of the Client Username. 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, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "default", - "x-configSyncTableType": "vpn", - "x-default": "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 - }, - "clientProfileName": { - "description": "The Client Profile of the Client Username. 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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "default", - "x-configSyncTableType": "vpn", - "x-default": "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 - }, - "clientUsername": { - "description": "The name of the Client Username.", - "maxLength": 189, - "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 the Client Username. When disabled, all clients currently connected as the Client Username are disconnected. 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 - }, - "guaranteedEndpointPermissionOverrideEnabled": { - "description": "Enable or disable guaranteed endpoint permission override for the Client Username. When enabled all guaranteed endpoints may be accessed, modified or deleted with the same permission as the owner. 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 - }, - "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 - }, - "password": { - "description": "The password for the Client Username. 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": 128, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "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-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true - }, - "subscriptionManagerEnabled": { - "description": "Enable or disable the subscription management capability of the Client Username. This is the ability to manage subscriptions on behalf of other Client Usernames. 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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnClientUsernameAttribute": { - "properties": { - "attributeName": { - "description": "The name of the Attribute.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z][A-Za-z0-9\\-]*$", - "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 - }, - "attributeValue": { - "description": "The value of the Attribute.", - "maxLength": 256, - "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 - }, - "clientUsername": { - "description": "The name of the Client Username.", - "maxLength": 189, - "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 - }, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnClientUsernameAttributeLinks": { - "properties": { - "uri": { - "description": "The URI of this Client Username Attribute object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnClientUsernameAttributeResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnClientUsernameAttribute" - }, - "links": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributeLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnClientUsernameAttributesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnClientUsernameAttribute" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributeLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnClientUsernameLinks": { - "properties": { - "attributesUri": { - "description": "The URI of this Client Username's collection of Client Username Attribute objects. Available since 2.27.", - "type": "string" - }, - "uri": { - "description": "The URI of this Client Username object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnClientUsernameResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnClientUsername" - }, - "links": { - "$ref": "#/definitions/MsgVpnClientUsernameLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnClientUsernamesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnClientUsername" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnClientUsernameLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCache": { - "properties": { - "cacheName": { - "description": "The name of the Distributed Cache.", - "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 - }, - "cacheVirtualRouter": { - "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", - "x-accessLevels": { - "get": "vpn/read-only" - }, - "x-autoDisable": [], - "x-configSyncDefault": "auto", - "x-default": "auto", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "enabled": { - "description": "Enable or disable the Distributed Cache. 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 - }, - "heartbeat": { - "description": "The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`.", - "format": "int64", - "maximum": 60, - "minimum": 3, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 10, - "x-configSyncTableType": "vpn", - "x-default": 10, - "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 - }, - "scheduledDeleteMsgDayList": { - "description": "The scheduled delete message day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgTimeList\" must also be configured to the empty-string). 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", - "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-requires": [ - "scheduledDeleteMsgTimeList" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "scheduledDeleteMsgTimeList": { - "description": "The scheduled delete message time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgDayList\" must also be configured to the empty-string). 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", - "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-requires": [ - "scheduledDeleteMsgDayList" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnDistributedCacheCluster": { - "properties": { - "cacheName": { - "description": "The name of the Distributed Cache.", - "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 - }, - "clusterName": { - "description": "The name of the Cache Cluster.", - "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 - }, - "deliverToOneOverrideEnabled": { - "description": "Enable or disable deliver-to-one override for the Cache 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 `true`.", - "type": "boolean", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "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 - }, - "enabled": { - "description": "Enable or disable the Cache Cluster. 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 - }, - "eventDataByteRateThreshold": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterEventDataByteRateThreshold" - }, - "eventDataMsgRateThreshold": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterEventDataMsgRateThreshold" - }, - "eventMaxMemoryThreshold": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterEventMaxMemoryThreshold" - }, - "eventMaxTopicsThreshold": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterEventMaxTopicsThreshold" - }, - "eventRequestQueueDepthThreshold": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold" - }, - "eventRequestRateThreshold": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterEventRequestRateThreshold" - }, - "eventResponseRateThreshold": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterEventResponseRateThreshold" - }, - "globalCachingEnabled": { - "description": "Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. 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 - }, - "globalCachingHeartbeat": { - "description": "The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int64", - "maximum": 255, - "minimum": 1, - "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 - }, - "globalCachingTopicLifetime": { - "description": "The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3600, - "x-configSyncTableType": "vpn", - "x-default": 3600, - "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 - }, - "maxMemory": { - "description": "The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`.", - "format": "int64", - "maximum": 2147483647, - "minimum": 128, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 2048, - "x-configSyncTableType": "vpn", - "x-default": 2048, - "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 - }, - "maxMsgsPerTopic": { - "description": "The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", - "format": "int64", - "maximum": 2147483647, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "maxRequestQueueDepth": { - "description": "The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`.", - "format": "int64", - "maximum": 200000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 100000, - "x-configSyncTableType": "vpn", - "x-default": 100000, - "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 - }, - "maxTopicCount": { - "description": "The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000000`.", - "format": "int64", - "maximum": 4294967294, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 2000000, - "x-configSyncTableType": "vpn", - "x-default": 2000000, - "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 - }, - "msgLifetime": { - "description": "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. 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": [], - "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, - "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 - }, - "newTopicAdvertisementEnabled": { - "description": "Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. 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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnDistributedCacheClusterEventDataByteRateThreshold": { - "description": "The thresholds for the cached data incoming byte rate event, in bytes per second.", - "properties": { - "clearValue": { - "description": "The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 187500000, - "x-configSyncTableType": "vpn", - "x-default": 187500000, - "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-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 250000000, - "x-configSyncTableType": "vpn", - "x-default": 250000000, - "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-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterEventDataMsgRateThreshold": { - "description": "The thresholds for the cached data incoming message rate event, in messages per second.", - "properties": { - "clearValue": { - "description": "The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 36000, - "x-configSyncTableType": "vpn", - "x-default": 36000, - "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-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 48000, - "x-configSyncTableType": "vpn", - "x-default": 48000, - "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-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterEventMaxMemoryThreshold": { - "description": "The thresholds for the memory usage per instance event, relative to `maxMemory`.", - "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.", - "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": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterEventMaxTopicsThreshold": { - "description": "The thresholds for the topics per instance event, relative to `maxTopicCount`.", - "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.", - "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": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold": { - "description": "The thresholds for the request queue depth event, relative to `maxRequestQueueDepth`.", - "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.", - "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": 60, - "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-requires": [ - "setPercent" - ], - "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.", - "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-default": 80, - "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-requires": [ - "clearPercent" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterEventRequestRateThreshold": { - "description": "The thresholds for the cache request message rate event, in messages per second.", - "properties": { - "clearValue": { - "description": "The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 25000, - "x-configSyncTableType": "vpn", - "x-default": 25000, - "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-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterEventResponseRateThreshold": { - "description": "The thresholds for the cache response message rate event, in messages per second.", - "properties": { - "clearValue": { - "description": "The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 80000, - "x-configSyncTableType": "vpn", - "x-default": 80000, - "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-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeCluster": { - "properties": { - "cacheName": { - "description": "The name of the Distributed Cache.", - "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 - }, - "clusterName": { - "description": "The name of the Cache Cluster.", - "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 - }, - "homeClusterName": { - "description": "The name of the remote Home Cache Cluster.", - "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 - }, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks": { - "properties": { - "topicPrefixesUri": { - "description": "The URI of this Home Cache Cluster's collection of Topic Prefix objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Home Cache Cluster object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" - }, - "links": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix": { - "properties": { - "cacheName": { - "description": "The name of the Distributed Cache.", - "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 - }, - "clusterName": { - "description": "The name of the Cache Cluster.", - "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 - }, - "homeClusterName": { - "description": "The name of the remote Home Cache Cluster.", - "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 - }, - "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 - }, - "topicPrefix": { - "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", - "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" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks": { - "properties": { - "uri": { - "description": "The URI of this Topic Prefix object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix" - }, - "links": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterInstance": { - "properties": { - "autoStartEnabled": { - "description": "Enable or disable auto-start for the Cache Instance. When enabled, the Cache Instance will automatically attempt to transition from the Stopped operational state to Up whenever it restarts or reconnects to the message broker. 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 - }, - "cacheName": { - "description": "The name of the Distributed Cache.", - "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 - }, - "clusterName": { - "description": "The name of the Cache Cluster.", - "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 - }, - "enabled": { - "description": "Enable or disable the Cache Instance. 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 - }, - "instanceName": { - "description": "The name of the Cache Instance.", - "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 - }, - "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 - }, - "stopOnLostMsgEnabled": { - "description": "Enable or disable stop-on-lost-message for the Cache Instance. When enabled, the Cache Instance will transition to the stopped operational state upon losing a message. When stopped, it cannot accept or respond to cache requests, but continues to cache messages. 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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnDistributedCacheClusterInstanceLinks": { - "properties": { - "uri": { - "description": "The URI of this Cache Instance object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterInstanceResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" - }, - "links": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterInstancesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterLinks": { - "properties": { - "globalCachingHomeClustersUri": { - "description": "The URI of this Cache Cluster's collection of Home Cache Cluster objects.", - "type": "string" - }, - "instancesUri": { - "description": "The URI of this Cache Cluster's collection of Cache Instance objects.", - "type": "string" - }, - "topicsUri": { - "description": "The URI of this Cache Cluster's collection of Topic objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Cache Cluster object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" - }, - "links": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterTopic": { - "properties": { - "cacheName": { - "description": "The name of the Distributed Cache.", - "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 - }, - "clusterName": { - "description": "The name of the Cache Cluster.", - "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 - }, - "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 - }, - "topic": { - "description": "The value of the Topic in the form a/b/c.", - "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" - }, - "MsgVpnDistributedCacheClusterTopicLinks": { - "properties": { - "uri": { - "description": "The URI of this Topic object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheClusterTopicResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" - }, - "links": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClusterTopicsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheClustersResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCacheLinks": { - "properties": { - "clustersUri": { - "description": "The URI of this Distributed Cache's collection of Cache Cluster objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Distributed Cache object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnDistributedCacheResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnDistributedCache" - }, - "links": { - "$ref": "#/definitions/MsgVpnDistributedCacheLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDistributedCachesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCache" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnDistributedCacheLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDmrBridge": { - "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 - }, - "remoteMsgVpnName": { - "description": "The remote Message VPN of the DMR Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 32, - "minLength": 0, - "pattern": "^[^*?]*$", - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "global/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 - }, - "remoteNodeName": { - "description": "The name of the node at the remote end of the DMR Bridge.", - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnDmrBridgeLinks": { - "properties": { - "uri": { - "description": "The URI of this DMR Bridge object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnDmrBridgeResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnDmrBridge" - }, - "links": { - "$ref": "#/definitions/MsgVpnDmrBridgeLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnDmrBridgesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnDmrBridge" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnDmrBridgeLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnEventConnectionCountThreshold": { - "description": "The thresholds for the client connection count event of the Message VPN, relative to `maxConnectionCount`.", - "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": 200000, - "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": 200000, - "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" - }, - "MsgVpnEventEgressFlowCountThreshold": { - "description": "The thresholds for the egress flow count event of the Message VPN, relative to `maxEgressFlowCount`.", - "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" - }, - "MsgVpnEventEgressMsgRateThreshold": { - "description": "The thresholds for the egress message rate event of the Message VPN.", - "properties": { - "clearValue": { - "description": "The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3000000, - "x-configSyncTableType": "vpn", - "x-default": 3000000, - "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-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4000000, - "x-configSyncTableType": "vpn", - "x-default": 4000000, - "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-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnEventEndpointCountThreshold": { - "description": "The thresholds for the Queues and Topic Endpoints count event of the Message VPN, relative to `maxEndpointCount`.", - "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" - }, - "MsgVpnEventIngressFlowCountThreshold": { - "description": "The thresholds for the receive flow count event of the Message VPN, relative to `maxIngressFlowCount`.", - "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" - }, - "MsgVpnEventIngressMsgRateThreshold": { - "description": "The thresholds for the receive message rate event of the Message VPN.", - "properties": { - "clearValue": { - "description": "The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3000000, - "x-configSyncTableType": "vpn", - "x-default": 3000000, - "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-requires": [ - "setValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "setValue": { - "description": "The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event.", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 4000000, - "x-configSyncTableType": "vpn", - "x-default": 4000000, - "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-requires": [ - "clearValue" - ], - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "type": "object" - }, - "MsgVpnEventMsgSpoolUsageThreshold": { - "description": "The thresholds for the message spool usage event of the Message VPN, 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", - "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" - }, - "MsgVpnEventServiceAmqpConnectionCountThreshold": { - "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.", - "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": 200000, - "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": 200000, - "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" - }, - "MsgVpnEventServiceMqttConnectionCountThreshold": { - "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.", - "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": 200000, - "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": 200000, - "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" - }, - "MsgVpnEventServiceRestIncomingConnectionCountThreshold": { - "description": "The thresholds for the incoming REST client connection count event of the Message VPN, relative to `serviceRestIncomingMaxConnectionCount`.", - "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": 200000, - "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": 200000, - "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" - }, - "MsgVpnEventServiceSmfConnectionCountThreshold": { - "description": "The thresholds for the SMF client connection count event of the Message VPN, relative to `serviceSmfMaxConnectionCount`.", - "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": 200000, - "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": 200000, - "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" - }, - "MsgVpnEventServiceWebConnectionCountThreshold": { - "description": "The thresholds for the Web Transport client connection count event of the Message VPN, relative to `serviceWebMaxConnectionCount`.", - "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": 200000, - "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": 200000, - "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" - }, - "MsgVpnEventSubscriptionCountThreshold": { - "description": "The thresholds for the subscription count event of the Message VPN, relative to `maxSubscriptionCount`.", - "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" - }, - "MsgVpnEventTransactedSessionCountThreshold": { - "description": "The thresholds for the transacted session count event of the Message VPN, relative to `maxTransactedSessionCount`.", - "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" - }, - "MsgVpnEventTransactionCountThreshold": { - "description": "The thresholds for the transaction count event of the Message VPN, relative to `maxTransactionCount`.", - "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" - }, - "MsgVpnJndiConnectionFactoriesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "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`.", - "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 - }, - "clientDescription": { - "description": "The description of the Client. 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": [], - "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 - }, - "clientId": { - "description": "The Client identifier (ID). If not specified, a unique value for it will be generated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 250, - "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 - }, - "connectionFactoryName": { - "description": "The name of the JMS Connection Factory.", - "maxLength": 256, - "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 - }, - "dtoReceiveOverrideEnabled": { - "description": "Enable or disable overriding by the Subscriber (Consumer) of the deliver-to-one (DTO) property on messages. When enabled, the Subscriber can receive all DTO tagged messages. 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 - }, - "dtoReceiveSubscriberLocalPriority": { - "description": "The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on the local broker that the Subscriber is directly connected to. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", - "format": "int32", - "maximum": 4, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "dtoReceiveSubscriberNetworkPriority": { - "description": "The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on a remote broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", - "format": "int32", - "maximum": 4, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "dtoSendEnabled": { - "description": "Enable or disable the deliver-to-one (DTO) property on messages sent by the Publisher (Producer). 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 - }, - "dynamicEndpointCreateDurableEnabled": { - "description": "Enable or disable whether a durable endpoint will be dynamically created on the broker when the client calls \"Session.createDurableSubscriber()\" or \"Session.createQueue()\". The created endpoint respects the message time-to-live (TTL) according to the \"dynamicEndpointRespectTtlEnabled\" property. 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 - }, - "dynamicEndpointRespectTtlEnabled": { - "description": "Enable or disable whether dynamically created durable and non-durable endpoints respect the message time-to-live (TTL) property. 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 - }, - "guaranteedReceiveAckTimeout": { - "description": "The timeout for sending the acknowledgment (ACK) for guaranteed messages received by the Subscriber (Consumer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", - "format": "int32", - "maximum": 1500, - "minimum": 20, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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 - }, - "guaranteedReceiveReconnectRetryCount": { - "description": "The maximum number of attempts to reconnect to the host or list of hosts after the guaranteed messaging connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.14.", - "format": "int32", - "maximum": 2147483647, - "minimum": -1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": -1, - "x-configSyncTableType": "vpn", - "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 - }, - "guaranteedReceiveReconnectRetryWait": { - "description": "The amount of time to wait before making another attempt to connect or reconnect to the host after the guaranteed messaging connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. Available since 2.14.", - "format": "int32", - "maximum": 2147483647, - "minimum": 50, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3000, - "x-configSyncTableType": "vpn", - "x-default": 3000, - "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 - }, - "guaranteedReceiveWindowSize": { - "description": "The size of the window for guaranteed messages received by the Subscriber (Consumer), in messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `18`.", - "format": "int32", - "maximum": 255, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 18, - "x-configSyncTableType": "vpn", - "x-default": 18, - "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 - }, - "guaranteedReceiveWindowSizeAckThreshold": { - "description": "The threshold for sending the acknowledgment (ACK) for guaranteed messages received by the Subscriber (Consumer) as a percentage of `guaranteedReceiveWindowSize`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60`.", - "format": "int32", - "maximum": 75, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 60, - "x-configSyncTableType": "vpn", - "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-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "guaranteedSendAckTimeout": { - "description": "The timeout for receiving the acknowledgment (ACK) for guaranteed messages sent by the Publisher (Producer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000`.", - "format": "int32", - "maximum": 60000, - "minimum": 20, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 2000, - "x-configSyncTableType": "vpn", - "x-default": 2000, - "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 - }, - "guaranteedSendWindowSize": { - "description": "The size of the window for non-persistent guaranteed messages sent by the Publisher (Producer), in messages. For persistent messages the window size is fixed at 1. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", - "format": "int32", - "maximum": 255, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 255, - "x-configSyncTableType": "vpn", - "x-default": 255, - "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 - }, - "messagingDefaultDeliveryMode": { - "description": "The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"persistent\"`. The allowed values and their meaning are:\n\n
\n\"persistent\" - The broker spools messages (persists in the Message Spool) as part of the send operation.\n\"non-persistent\" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation.\n
\n", - "enum": [ - "persistent", - "non-persistent" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "persistent", - "x-configSyncTableType": "vpn", - "x-default": "persistent", - "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 - }, - "messagingDefaultDmqEligibleEnabled": { - "description": "Enable or disable whether messages sent by the Publisher (Producer) are Dead Message Queue (DMQ) eligible by default. 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 - }, - "messagingDefaultElidingEligibleEnabled": { - "description": "Enable or disable whether messages sent by the Publisher (Producer) are Eliding eligible by default. 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 - }, - "messagingJmsxUserIdEnabled": { - "description": "Enable or disable inclusion (adding or replacing) of the JMSXUserID property in messages sent by the Publisher (Producer). 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 - }, - "messagingTextInXmlPayloadEnabled": { - "description": "Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. 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 - }, - "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 - }, - "transportCompressionLevel": { - "description": "The ZLIB compression level for the connection to the broker. The value \"0\" means no compression, and the value \"-1\" means the compression level is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", - "format": "int32", - "maximum": 9, - "minimum": -1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": -1, - "x-configSyncTableType": "vpn", - "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 - }, - "transportConnectRetryCount": { - "description": "The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" 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": "int32", - "maximum": 2147483647, - "minimum": -1, - "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 - }, - "transportConnectRetryPerHostCount": { - "description": "The maximum number of retry attempts to establish an initial connection to each host on the list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" 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": "int32", - "maximum": 2147483647, - "minimum": -1, - "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 - }, - "transportConnectTimeout": { - "description": "The timeout for establishing an initial connection to the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`.", - "format": "int32", - "maximum": 2147483647, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 30000, - "x-configSyncTableType": "vpn", - "x-default": 30000, - "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 - }, - "transportDirectTransportEnabled": { - "description": "Enable or disable usage of Direct Transport mode. When enabled, NON-PERSISTENT messages are sent as direct messages and non-durable topic consumers and temporary queue consumers consume using direct subscriptions rather than from guaranteed endpoints. If disabled all messaging uses guaranteed transport. 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 - }, - "transportKeepaliveCount": { - "description": "The maximum number of consecutive application-level keepalive messages sent without the broker response before the connection to the broker is closed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int32", - "maximum": 2147483647, - "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 - }, - "transportKeepaliveEnabled": { - "description": "Enable or disable usage of application-level keepalive messages to maintain a connection with the broker. 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 - }, - "transportKeepaliveInterval": { - "description": "The interval between application-level keepalive messages, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", - "format": "int32", - "maximum": 2147483647, - "minimum": 50, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3000, - "x-configSyncTableType": "vpn", - "x-default": 3000, - "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 - }, - "transportMsgCallbackOnIoThreadEnabled": { - "description": "Enable or disable delivery of asynchronous messages directly from the I/O thread. Contact support before enabling this property. 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 - }, - "transportOptimizeDirectEnabled": { - "description": "Enable or disable optimization for the Direct Transport delivery mode. If enabled, the client application is limited to one Publisher (Producer) and one non-durable Subscriber (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", - "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 - }, - "transportPort": { - "description": "The connection port number on the broker for SMF clients. The value \"-1\" means the port is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", - "format": "int32", - "maximum": 65535, - "minimum": -1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": -1, - "x-configSyncTableType": "vpn", - "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 - }, - "transportReadTimeout": { - "description": "The timeout for reading a reply from the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", - "format": "int32", - "maximum": 2147483647, - "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-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 - }, - "transportReceiveBufferSize": { - "description": "The size of the receive socket buffer, in bytes. It corresponds to the SO_RCVBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`.", - "format": "int32", - "maximum": 2147483647, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 65536, - "x-configSyncTableType": "vpn", - "x-default": 65536, - "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 - }, - "transportReconnectRetryCount": { - "description": "The maximum number of attempts to reconnect to the host or list of hosts after the connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", - "format": "int32", - "maximum": 2147483647, - "minimum": -1, - "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 - }, - "transportReconnectRetryWait": { - "description": "The amount of time before making another attempt to connect or reconnect to the host after the connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", - "format": "int32", - "maximum": 60000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 3000, - "x-configSyncTableType": "vpn", - "x-default": 3000, - "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 - }, - "transportSendBufferSize": { - "description": "The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`.", - "format": "int32", - "maximum": 2147483647, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 65536, - "x-configSyncTableType": "vpn", - "x-default": 65536, - "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 - }, - "transportTcpNoDelayEnabled": { - "description": "Enable or disable the TCP_NODELAY option. When enabled, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled. 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 - }, - "xaEnabled": { - "description": "Enable or disable this as an XA Connection Factory. When enabled, the Connection Factory can be cast to \"XAConnectionFactory\", \"XAQueueConnectionFactory\" or \"XATopicConnectionFactory\". 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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnJndiConnectionFactoryLinks": { - "properties": { - "uri": { - "description": "The URI of this JNDI Connection Factory object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnJndiConnectionFactoryResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - }, - "links": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnJndiQueue": { - "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 - }, - "physicalName": { - "description": "The physical name of the JMS Queue. 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 - }, - "queueName": { - "description": "The JNDI name of the JMS Queue.", - "maxLength": 256, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnJndiQueueLinks": { - "properties": { - "uri": { - "description": "The URI of this JNDI Queue object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnJndiQueueResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnJndiQueue" - }, - "links": { - "$ref": "#/definitions/MsgVpnJndiQueueLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnJndiQueuesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnJndiQueue" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnJndiQueueLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnJndiTopic": { - "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 - }, - "physicalName": { - "description": "The physical name of the JMS Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 250, - "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 - }, - "topicName": { - "description": "The JNDI name of the JMS Topic.", - "maxLength": 256, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnJndiTopicLinks": { - "properties": { - "uri": { - "description": "The URI of this JNDI Topic object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnJndiTopicResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnJndiTopic" - }, - "links": { - "$ref": "#/definitions/MsgVpnJndiTopicLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnJndiTopicsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnJndiTopic" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnJndiTopicLinks" - }, - "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.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": { - "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", - "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 - }, - "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": [], - "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, - "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 - } - }, - "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": [], - "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 - }, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "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": 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" - ], - "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 - }, - "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": [], - "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 - }, - "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": [], - "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 - }, - "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": [], - "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 - }, - "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": 10000, - "x-configSyncTableType": "vpn", - "x-default": 10000, - "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 - }, - "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": [], - "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 - }, - "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": [], - "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 - }, - "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.", - "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" - }, - "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": "^[^*?]+$", - "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 - }, - "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, - "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" - }, - "MsgVpnMqttSessionSubscriptionLinks": { - "properties": { - "uri": { - "description": "The URI of this 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": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnMqttSession" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnMqttSessionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnProxiesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnProxy" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnProxyLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnProxy": { - "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, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "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 - }, - "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", - "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 - }, - "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": [], - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 0, - "x-configSyncTableType": "router", - "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 - }, - "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", - "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": 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\"`.", - "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-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/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": [], - "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 - }, - "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": [], - "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 - }, - "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": [], - "x-configSyncDefault": 10000, - "x-configSyncTableType": "vpn", - "x-default": 10000, - "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 - }, - "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": [], - "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 - }, - "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": [], - "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 - }, - "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": [], - "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 - }, - "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": 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, - "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 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" - ], - "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", - "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 - }, - "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" - ], - "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 - }, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "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 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", - "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 - }, - "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 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", - "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 `\"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" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "rejectLowPriorityMsgEnabled" - ], - "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 - }, - "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": [ - "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 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": 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" - }, - "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": 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" - }, - "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.", - "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" - }, - "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.", - "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" - }, - "MsgVpnQueueLinks": { - "properties": { - "subscriptionsUri": { - "description": "The URI of this Queue's collection of Queue Subscription objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Queue object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnQueueResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnQueue" - }, - "links": { - "$ref": "#/definitions/MsgVpnQueueLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "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": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnQueueSubscription" - }, - "links": { - "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnQueueSubscriptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnQueueSubscription" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnQueueTemplate": { - "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`.", - "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). 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-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 - }, - "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": "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 - }, - "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" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "none", - "x-configSyncTableType": "vpn", - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 10000, - "x-configSyncTableType": "vpn", - "x-default": 10000, - "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 - }, - "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", - "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 - }, - "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", - "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 - }, - "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", - "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 - }, - "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" - }, - "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, - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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 - }, - "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": [], - "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 - }, - "queueTemplateName": { - "description": "The name of the Queue Template.", - "maxLength": 255, - "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 - }, - "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", - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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. 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": 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. 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": 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 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", - "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 - }, - "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 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 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" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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 - }, - "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", - "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 - }, - "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", - "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" - }, - "MsgVpnQueueTemplateEventBindCountThreshold": { - "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": 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": 10000, - "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": 10000, - "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" - }, - "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", - "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": 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": [ - "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" - }, - "MsgVpnQueueTemplateLinks": { - "properties": { - "uri": { - "description": "The URI of this Queue Template object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnQueueTemplateResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnQueueTemplate" - }, - "links": { - "$ref": "#/definitions/MsgVpnQueueTemplateLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnQueueTemplatesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnQueueTemplate" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnQueueTemplateLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnQueuesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnQueue" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/MsgVpnQueueLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnReplayLog": { - "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", - "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 - }, - "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", - "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, - "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 - }, - "replayLogName": { - "description": "The name of the Replay Log.", - "maxLength": 185, - "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 - }, - "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": 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": "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" - }, - "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" - }, - "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 - }, - "replayLogName": { - "description": "The name of the Replay Log.", - "maxLength": 185, - "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 - }, - "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" - } - }, - "type": "object" - }, - "MsgVpnReplayLogTopicFilterSubscriptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" - }, - "links": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnReplayLogTopicFilterSubscriptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" - }, - "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, - "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 - }, - "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" - }, - "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 - }, - "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": "async", - "x-configSyncTableType": "vpn", - "x-default": "async", - "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" - }, - "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" - }, - "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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "default", - "x-configSyncTableType": "vpn", - "x-default": "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 - }, - "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", - "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 - }, - "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 - }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "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 - }, - "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": "", - "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 - }, - "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": "", - "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": "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.8.", - "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 - }, - "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 - }, - "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": "", - "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 - }, - "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": "none", - "x-configSyncTableType": "vpn", - "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 - }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "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 - } - }, - "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!#$%&'*+\\-.\\^_`|~]*$", - "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 - }, - "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": { - "patch": "vpn/read-write" - }, - "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-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true - }, - "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 - }, - "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": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "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", - "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", - "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!#$%&'*+\\-.\\^_`|~]*$", - "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 - }, - "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": "", - "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 - }, - "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 - }, - "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": false, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": true, - "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", - "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", - "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.", - "maxLength": 32, - "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 - }, - "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", - "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 - }, - "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": { - "patch": "vpn/read-write" - }, - "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-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true - }, - "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": [], - "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 - }, - "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": { - "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 - }, - "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": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-default": "", - "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": [ - "authenticationClientCertContent" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "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": { - "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": [ - "authenticationHttpBasicUsername" - ], - "x-requiresDisable": [], - "x-writeOnly": true - }, - "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": [ - "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-requires": [ - "authenticationHttpBasicPassword" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "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", - "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 - }, - "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": { - "patch": "vpn/read-write" - }, - "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-readOnlyPost": false, - "x-readOptional": true, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": true - }, - "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", - "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 - }, - "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": [ - "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 - }, - "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, - "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 - }, - "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 - }, - "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" - }, - "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 - }, - "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": [ - "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 - }, - "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 - }, - "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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "none", - "x-configSyncTableType": "vpn", - "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 - }, - "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", - "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 - }, - "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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "post", - "x-configSyncTableType": "vpn", - "x-default": "post", - "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 - }, - "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": { - "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 - }, - "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" - }, - "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 - }, - "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 - }, - "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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "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 - }, - "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" - }, - "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 - }, - "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": [ - "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 - }, - "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": [ - "enabled" - ], - "x-configSyncDefault": 8080, - "x-configSyncTableType": "vpn", - "x-default": 8080, - "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-requires": [ - "tlsEnabled" - ], - "x-requiresDisable": [], - "x-writeOnly": false - }, - "restConsumerName": { - "description": "The name of the REST Consumer.", - "maxLength": 32, - "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 - }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "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 - }, - "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": [], - "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 - }, - "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": "default", - "x-configSyncTableType": "vpn", - "x-default": "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 - }, - "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" - }, - "x-autoDisable": [ - "enabled" - ], - "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-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" - }, - "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" - }, - "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 - }, - "oauthJwtClaimName": { - "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", - "maxLength": 100, - "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 - }, - "oauthJwtClaimValue": { - "description": "The value of the additional claim, which must be a string containing a valid JSON value.", - "maxLength": 200, - "minLength": 1, - "type": "string", - "x-accessLevels": { - "get": "vpn/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 - }, - "restConsumerName": { - "description": "The name of the REST Consumer.", - "maxLength": 32, - "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 - }, - "restDeliveryPointName": { - "description": "The name of the REST Delivery Point.", - "maxLength": 100, - "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 - } - }, - "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" - }, - "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" - }, - "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" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "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" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "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" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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 - }, - "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" - }, - "x-autoDisable": [], - "x-deprecated": true, - "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" - }, - "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": { - "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, - "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 - }, - "sequencedTopic": { - "description": "Topic for applying sequence numbers.", - "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" - }, - "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-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`.", - "format": "int64", - "maximum": 10000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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 - }, - "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": 6000000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 800000, - "x-configSyncTableType": "vpn", - "x-default": 800000, - "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 - }, - "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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": "disallow", - "x-configSyncTableType": "vpn", - "x-default": "disallow", - "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 - }, - "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", - "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 - }, - "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-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 - }, - "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": [], - "x-configSyncDefault": 2, - "x-configSyncTableType": "vpn", - "x-default": 2, - "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 - }, - "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": [], - "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 - }, - "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 - }, - "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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "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", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1460, - "x-configSyncTableType": "vpn", - "x-default": 1460, - "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 - }, - "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", - "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": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "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": 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-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", - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnTelemetryProfileLinks": { - "properties": { - "receiverAclConnectExceptionsUri": { - "description": "The URI of this Telemetry Profile's collection of Receiver ACL Connect Exception objects.", - "type": "string" - }, - "traceFiltersUri": { - "description": "The URI of this Telemetry Profile's collection of Trace Filter objects.", - "type": "string" - }, - "uri": { - "description": "The URI of this Telemetry Profile object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnTelemetryProfileQueueEventBindCountThreshold": { - "description": "The thresholds for the Queue consumer flows event, relative to `queueMaxBindCount`.", - "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" - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "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 - }, - "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": 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 - }, - "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" - }, - "MsgVpnTelemetryProfileReceiverAclConnectException": { - "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 - }, - "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" - }, - "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 - }, - "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", - "x-accessLevels": { - "delete": "vpn/read-write", - "post": "vpn/read-write" - }, - "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`.", - "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": 200000, - "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": 200000, - "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" - }, - "MsgVpnTelemetryProfileResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnTelemetryProfile" - }, - "links": { - "$ref": "#/definitions/MsgVpnTelemetryProfileLinks" - }, - "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, - "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 - }, - "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 - }, - "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" - }, - "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" - }, - "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": { - "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 - }, - "subscription": { - "description": "Messages matching this subscription will follow this filter's configuration.", - "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 - }, - "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" - }, - "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 - }, - "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 - }, - "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" - }, - "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": "vpn/read-write", - "post": "vpn/read-write" - }, - "x-configSyncTableTypeCreateDelete": "vpn" - }, - "MsgVpnTelemetryProfileTraceFilterSubscriptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Telemetry Trace Filter Subscription 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": { - "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": 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 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-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 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", - "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 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" - }, - "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-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 - }, - "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": 10000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "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": 1000000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 10000, - "x-configSyncTableType": "vpn", - "x-default": 10000, - "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 - }, - "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, - "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 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", - "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": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "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", - "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": "^[^*?'<>&;]+$", - "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" - }, - "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.", - "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" - }, - "MsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold": { - "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", - "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" - }, - "MsgVpnTopicEndpointEventSpoolUsageThreshold": { - "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", - "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" - }, - "MsgVpnTopicEndpointLinks": { - "properties": { - "uri": { - "description": "The URI of this Topic Endpoint object.", - "type": "string" - } - }, - "type": "object" - }, - "MsgVpnTopicEndpointResponse": { - "properties": { - "data": { - "$ref": "#/definitions/MsgVpnTopicEndpoint" - }, - "links": { - "$ref": "#/definitions/MsgVpnTopicEndpointLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "MsgVpnTopicEndpointTemplate": { - "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`.", - "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). 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-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 - }, - "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", - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 1, - "x-configSyncTableType": "vpn", - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "x-configSyncDefault": 10000, - "x-configSyncTableType": "vpn", - "x-default": 10000, - "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 - }, - "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", - "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 - }, - "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", - "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 - }, - "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", - "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 - }, - "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, - "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 - }, - "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", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [], - "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. 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": [], - "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. 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": [], - "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. 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": 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. 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": 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": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "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", - "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 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, - "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. 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": [], - "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 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": [], - "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. 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 - }, - "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": "^[^#?*][^?*]*$", - "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" - }, - "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", - "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": 10000, - "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": 10000, - "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" - }, - "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", - "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": 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": [ - "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" - }, - "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", - "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" - }, - "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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "groups", - "x-configSyncTableType": "router", - "x-default": "groups", - "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 - }, - "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": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "single", - "x-configSyncTableType": "router", - "x-default": "single", - "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 - }, - "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", - "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 - }, - "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": "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 - }, - "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": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "JWT", - "x-configSyncTableType": "router", - "x-default": "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 - }, - "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": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "openid email", - "x-configSyncTableType": "router", - "x-default": "openid email", - "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 - }, - "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": { - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": "", - "x-configSyncTableType": "router", - "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 - }, - "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, - "x-readOptional": false, - "x-requiredPost": false, - "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", - "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 - }, - "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": "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 - }, - "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": "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 - }, - "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": "global/read-only", - "patch": "global/admin" - }, - "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 - }, - "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": "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 - }, - "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": "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 - }, - "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", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "router", - "x-default": 86400, - "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 - }, - "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": "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 - }, - "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 - }, - "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" - }, - "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 - }, - "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": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "x-configSyncDefault": 86400, - "x-configSyncTableType": "router", - "x-default": 86400, - "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 - }, - "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": "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 - }, - "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": "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 - }, - "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": "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 - }, - "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": "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 - }, - "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" - }, - "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 - }, - "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" - }, - "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 - }, - "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": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "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": false, - "x-requiredPost": false, - "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, - "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 - }, - "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": true, - "x-opaque": false, - "x-readOnlyOther": true, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": true, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "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": "global/read-only", - "patch": "global/admin" - }, - "x-autoDisable": [], - "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": false, - "x-requiredPost": false, - "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", - "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 - }, - "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": "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 - }, - "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-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - } - }, - "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": { - "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 - }, - "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 - }, - "groupName": { - "description": "The name of the group.", - "maxLength": 64, - "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 - }, - "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" - }, - "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 - }, - "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" - }, - "OauthProfileAccessLevelGroupLinks": { - "properties": { - "msgVpnAccessLevelExceptionsUri": { - "description": "The URI of this Group Access Level's collection of Message VPN Access-Level Exception objects.", - "type": "string" - }, - "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/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, - "minLength": 1, - "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 - }, - "msgVpnName": { - "description": "The name of the message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "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 - }, - "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" - }, - "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks": { - "properties": { - "uri": { - "description": "The URI of this Message VPN Access-Level Exception object.", - "type": "string" - } - }, - "type": "object" - }, - "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse": { - "properties": { - "data": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" - }, - "links": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" - }, - "type": "array" - }, - "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" - }, - "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 - }, - "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/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" - }, - "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" - }, - "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 - }, - "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", - "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 - }, - "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/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" - }, - "type": "array" - }, - "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" - }, - "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 - }, - "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" - }, - "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 - }, - "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/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" - }, - "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": [ - "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 - }, - "msgVpnName": { - "description": "The name of the message VPN.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^*?]+$", - "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 - }, - "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-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" - }, - "ServiceRestEventOutgoingConnectionCountThreshold": { - "description": "The thresholds for the REST outgoing 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": 6000, - "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": 6000, - "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" - }, - "ServiceSmfEventConnectionCountThreshold": { - "description": "The thresholds for the SMF 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-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.4. /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.4. /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 - } - }, - "type": "object" - }, - "SystemInformationLinks": { - "properties": { - "uri": { - "description": "The URI of this System Information object.", - "type": "string" - } - }, - "type": "object" - }, - "SystemInformationResponse": { - "properties": { - "data": { - "$ref": "#/definitions/SystemInformation" - }, - "links": { - "$ref": "#/definitions/SystemInformationLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "VirtualHostname": { - "properties": { - "enabled": { - "description": "Enable or disable Virtual Hostname to Message VPN mapping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", - "type": "boolean", - "x-accessLevels": { - "get": "global/read-only", - "patch": "global/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 - }, - "msgVpnName": { - "description": "The message VPN to which this virtual hostname is mapped. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", - "maxLength": 32, - "minLength": 0, - "pattern": "^[^*?]*$", - "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 - }, - "virtualHostname": { - "description": "The virtual hostname.", - "maxLength": 253, - "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 - } - }, - "type": "object", - "x-accessLevels": { - "delete": "global/read-write", - "post": "global/read-write" - }, - "x-configSyncTableTypeCreateDelete": "router" - }, - "VirtualHostnameLinks": { - "properties": { - "uri": { - "description": "The URI of this Virtual Hostname object.", - "type": "string" - } - }, - "type": "object" - }, - "VirtualHostnameResponse": { - "properties": { - "data": { - "$ref": "#/definitions/VirtualHostname" - }, - "links": { - "$ref": "#/definitions/VirtualHostnameLinks" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - }, - "VirtualHostnamesResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/VirtualHostname" - }, - "type": "array" - }, - "links": { - "items": { - "$ref": "#/definitions/VirtualHostnameLinks" - }, - "type": "array" - }, - "meta": { - "$ref": "#/definitions/SempMeta" - } - }, - "required": [ - "meta" - ], - "type": "object" - } - }, - "host": "www.solace.com", - "info": { - "contact": { - "email": "support@solace.com", - "name": "Solace", - "url": "http://www.solace.com" - }, - "description": "SEMP (starting in `v2`) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. This specification defines the following API:\n\n\nAPI|Base Path|Purpose\n:---|:---|:---\nConfiguration|/SEMP/v2/config|Reading and writing configuration\n\n\n\nThe following APIs are also available:\n\n\nAPI|Base Path|Purpose\n:---|:---|:---\nAction|/SEMP/v2/action|Performing actions\nMonitoring|/SEMP/v2/monitor|Querying operational state\n\n\n\nFor tutorials, architectural and protocol design documentation, and other information about the SEMP API, consult the [SEMP documentation](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) on the Solace website. The SEMP API specifications are also [available for download](https://solace.com/downloads/).\n\nIf you need additional support, please contact us at [support@solace.com](mailto:support@solace.com).", - "title": "SEMP (Solace Element Management Protocol)", - "version": "2.38" - }, - "parameters": { - "countQuery": { - "default": 10, - "description": "Limit the count of objects in the response. See the documentation for the `count` parameter.", - "in": "query", - "minimum": 1, - "name": "count", - "required": false, - "type": "integer" - }, - "cursorQuery": { - "description": "The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter.", - "in": "query", - "name": "cursor", - "required": false, - "type": "string" - }, - "forceFullPageQuery": { - "default": false, - "description": "Make as many SEMP requests as are necessary to return a full page. This query parameter is only for Solace internal use.", - "in": "query", - "name": "forceFullPage", - "required": false, - "type": "boolean" - }, - "opaquePasswordQuery": { - "description": "Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter.", - "in": "query", - "name": "opaquePassword", - "required": false, - "type": "string" - }, - "selectQuery": { - "collectionFormat": "csv", - "description": "Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter.", - "in": "query", - "items": { - "type": "string" - }, - "name": "select", - "required": false, - "type": "array" - }, - "solSessionHeader": { - "description": "Modify the SEMPv2 session behavior. This header parameter is only for Solace internal use.", - "in": "header", - "name": "Sol-Session", - "required": false, - "type": "string" - }, - "whereQuery": { - "collectionFormat": "csv", - "description": "Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter.", - "in": "query", - "items": { - "type": "string" - }, - "name": "where", - "required": false, - "type": "array" - } - }, - "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\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": [ - { - "$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:---|:---:|:---:|:---:|:---:\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 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.4.", - "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.4.", - "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.4.", - "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.4.", - "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", - "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", - "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 OCSP Responder Trusted Common Name object.", - "tags": [ - "all", - "certAuthority" - ], - "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", - "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", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an OCSP Responder Trusted Common Name object.", - "tags": [ - "all", - "certAuthority" - ], - "x-supportedInSempDirect": false - } - }, - "/clientCertAuthorities": { - "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", - "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 Client Certificate Authority objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/ClientCertAuthoritiesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Client Certificate Authority objects.", - "tags": [ - "all", - "clientCertAuthority" - ], - "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", - "parameters": [ - { - "description": "The Client Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClientCertAuthority" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Certificate Authority object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Client Certificate Authority object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "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 - }, - "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", - "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 Client Certificate Authority object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Client Certificate Authority object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "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", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Certificate Authority object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Client Certificate Authority object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "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", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Certificate Authority object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/ClientCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Client Certificate Authority object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "x-supportedInSempDirect": false - } - }, - "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { - "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", - "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/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of OCSP Responder Trusted Common Name objects.", - "tags": [ - "all", - "clientCertAuthority" - ], - "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", - "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/ClientCertAuthorityOcspTlsTrustedCommonName" - } - }, - { - "$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/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an OCSP Responder Trusted Common Name object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "x-supportedInSempDirect": false - } - }, - "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}": { - "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", - "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", - "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 OCSP Responder Trusted Common Name object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "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", - "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", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an OCSP Responder Trusted Common Name object.", - "tags": [ - "all", - "clientCertAuthority" - ], - "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": [ - { - "$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 Cluster objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClustersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Cluster objects.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "parameters": [ - { - "description": "The Cluster object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cluster object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Cluster object.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "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 Cluster object.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cluster object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Cluster object.", - "tags": [ - "all", - "dmrCluster" - ], - "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.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The Cluster object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cluster object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Cluster object.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The Cluster object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cluster object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Cluster object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - } - }, - "/dmrClusters/{dmrClusterName}/certMatchingRules": { - "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", - "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRulesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Certificate Matching Rule objects.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Matching Rule object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Certificate Matching Rule object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - } - }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}": { - "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", - "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" - }, - { - "$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 object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - }, - "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", - "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" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Certificate Matching Rule object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - }, - "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", - "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 Certificate Matching Rule object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Certificate Matching Rule object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - }, - "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", - "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 Certificate Matching Rule object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRule" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Certificate Matching Rule object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - } - }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters": { - "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", - "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" - }, - { - "$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 Matching Rule Attribute Filter objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFiltersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - }, - "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", - "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 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 created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Certificate Matching Rule Attribute Filter object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - } - }, - "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { - "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", - "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" - }, - { - "$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": "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Certificate Matching Rule Attribute Filter object.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "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.", - "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": "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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Certificate Matching Rule Attribute Filter object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - } - }, - "/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", - "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" - }, - { - "$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 Matching Rule Condition objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Certificate Matching Rule Condition objects.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - }, - "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", - "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 Certificate Matching Rule Condition object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Certificate Matching Rule Condition 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", - "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": "Certificate field to be compared with the Attribute.", - "in": "path", - "name": "source", - "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 Matching Rule Condition object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - }, - "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", - "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": "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Certificate Matching Rule Condition object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - } - }, - "/dmrClusters/{dmrClusterName}/links": { - "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", - "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Link objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinksResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Link objects.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Cluster.", - "in": "path", - "name": "dmrClusterName", - "required": true, - "type": "string" - }, - { - "description": "The Link object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterLink" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Link object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Link object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - } - }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}": { - "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", - "parameters": [ - { - "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" - }, - { - "$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 Link object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "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" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Link object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Link object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - }, - "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": [ - { - "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/DmrClusterLink" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Link object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Link object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - }, - "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 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/DmrClusterLink" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Link object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Link object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - } - }, - "/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 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" - }, - { - "$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 Link Attribute objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkAttributesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Link Attribute objects.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "parameters": [ - { - "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 Attribute object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterLinkAttribute" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Link Attribute object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkAttributeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Link Attribute object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": true - } - }, - "/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 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 name of the Attribute.", - "in": "path", - "name": "attributeName", - "required": true, - "type": "string" - }, - { - "description": "The value of the Attribute.", - "in": "path", - "name": "attributeValue", - "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 Link Attribute 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", - "parameters": [ - { - "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 name of the Attribute.", - "in": "path", - "name": "attributeName", - "required": true, - "type": "string" - }, - { - "description": "The value of the Attribute.", - "in": "path", - "name": "attributeValue", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Link Attribute object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkAttributeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Link Attribute object.", - "tags": [ - "all", - "dmrCluster" - ], - "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 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" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Remote Address objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Remote Address objects.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - }, - "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 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 Remote Address object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddress" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Address object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Remote Address object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - } - }, - "/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 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 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" - } - ], - "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 Remote Address object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - }, - "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 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 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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Address object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Remote Address object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - } - }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames": { - "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", - "parameters": [ - { - "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" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNamesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Trusted Common Name objects.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "parameters": [ - { - "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 Trusted Common Name object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Trusted Common Name object.", - "tags": [ - "all", - "dmrCluster" - ], - "x-supportedInSempDirect": false - } - }, - "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { - "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", - "parameters": [ - { - "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 expected trusted common name of the remote certificate.", - "in": "path", - "name": "tlsTrustedCommonName", - "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 Trusted Common Name object.", - "tags": [ - "all", - "dmrCluster" - ], - "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", - "parameters": [ - { - "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 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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trusted Common Name object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Trusted Common Name 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", - "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 Domain Certificate Authority objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DomainCertAuthoritiesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Domain Certificate Authority objects.", - "tags": [ - "all", - "domainCertAuthority" - ], - "x-supportedInSempDirect": true - }, - "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 Domain Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DomainCertAuthority" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Domain Certificate Authority object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Domain Certificate Authority object.", - "tags": [ - "all", - "domainCertAuthority" - ], - "x-supportedInSempDirect": true - } - }, - "/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 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 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.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Domain Certificate Authority object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Domain Certificate Authority object.", - "tags": [ - "all", - "domainCertAuthority" - ], - "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 Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "description": "The Domain Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DomainCertAuthority" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Domain Certificate Authority object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Domain Certificate Authority object.", - "tags": [ - "all", - "domainCertAuthority" - ], - "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", - "parameters": [ - { - "description": "The name of the Certificate Authority.", - "in": "path", - "name": "certAuthorityName", - "required": true, - "type": "string" - }, - { - "description": "The Domain Certificate Authority object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DomainCertAuthority" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Domain Certificate Authority object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/DomainCertAuthorityResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Domain Certificate Authority object.", - "tags": [ - "all", - "domainCertAuthority" - ], - "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|||\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": [ - { - "$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 Message VPN objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Message VPN objects.", - "tags": [ - "all", - "msgVpn" - ], - "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|||\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 Message VPN object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpn" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Message VPN object.", - "tags": [ - "all", - "msgVpn" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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|||\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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Message VPN object.", - "tags": [ - "all", - "msgVpn" - ], - "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||||\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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpn" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Message VPN object.", - "tags": [ - "all", - "msgVpn" - ], - "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||||\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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpn" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Message VPN object.", - "tags": [ - "all", - "msgVpn" - ], - "x-supportedInSempDirect": false - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of ACL Profile objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of ACL Profile objects.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The ACL Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The ACL Profile object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an ACL Profile object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/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.", - "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/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 ACL Profile object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The ACL Profile object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an ACL Profile object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The ACL Profile object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an ACL Profile object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - }, - "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.", - "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.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The ACL Profile object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an ACL Profile object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/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", - "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" - }, - { - "$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 Client Connect Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Client Connect Exception objects.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - }, - "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", - "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 Client Connect Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Connect Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Client Connect Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 IP address/netmask of the client connect exception in canonical CIDR form.", - "in": "path", - "name": "clientConnectExceptionAddress", - "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 Connect Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - }, - "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", - "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 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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Connect Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Client Connect Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions": { - "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", - "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" - }, - { - "$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 Publish Topic Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Publish Topic Exception objects.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Publish Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}": { - "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", - "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 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" - } - ], - "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 Publish Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Publish Topic Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Publish Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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" - }, - { - "$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 Publish Topic Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Publish Topic Exception objects.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Publish Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 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", - "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 Publish Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 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", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Publish Topic Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Publish Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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" - }, - { - "$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 Subscribe Topic Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Subscribe Topic Exception objects.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 Subscribe Topic Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Subscribe Topic Exception 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", - "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 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", - "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 Subscribe Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 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", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Subscribe Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions": { - "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", - "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" - }, - { - "$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 Subscribe Share Name Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Subscribe Share Name Exception objects.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 Subscribe Share Name Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscribe Share Name Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Subscribe Share Name Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}": { - "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", - "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 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.", - "in": "path", - "name": "subscribeShareNameException", - "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 Subscribe Share Name Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 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.", - "in": "path", - "name": "subscribeShareNameException", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscribe Share Name Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Subscribe Share Name Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions": { - "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", - "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" - }, - { - "$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 Subscribe Topic Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Subscribe Topic Exception objects.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 Subscribe Topic Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Subscribe Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}": { - "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", - "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 syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "subscribeTopicExceptionSyntax", - "required": true, - "type": "string" - }, - { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "subscribeTopicException", - "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 Subscribe Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "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", - "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 syntax of the topic for the exception to the default action taken.", - "in": "path", - "name": "subscribeTopicExceptionSyntax", - "required": true, - "type": "string" - }, - { - "description": "The topic for the exception to the default action taken. May include wildcard characters.", - "in": "path", - "name": "subscribeTopicException", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Subscribe Topic Exception object.", - "tags": [ - "all", - "msgVpn", - "aclProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of OAuth Profile objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfilesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of OAuth Profile objects.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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 created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an OAuth Profile object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OAuth Profile object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an OAuth Profile object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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 replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an OAuth Profile object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Required Claim objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Required Claim objects.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "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/MsgVpnAuthenticationOauthProfileClientRequiredClaim" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Required Claim object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ID token claim to verify.", - "in": "path", - "name": "clientRequiredClaimName", - "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 Required Claim object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ID token claim to verify.", - "in": "path", - "name": "clientRequiredClaimName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Required Claim object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Required Claim objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Required Claim objects.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "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/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Required Claim object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the access token claim to verify.", - "in": "path", - "name": "resourceServerRequiredClaimName", - "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 Required Claim object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the access token claim to verify.", - "in": "path", - "name": "resourceServerRequiredClaimName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Required Claim object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProfile" - ], - "x-supportedInSempDirect": true - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of OAuth Provider objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProvidersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of OAuth Provider objects.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProvider" - ], - "x-supportedInSempDirect": true - }, - "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.", - "in": "path", - "name": "msgVpnName", - "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 created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an OAuth Provider object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProvider" - ], - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth Provider.", - "in": "path", - "name": "oauthProviderName", - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth Provider.", - "in": "path", - "name": "oauthProviderName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OAuth Provider object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an OAuth Provider object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProvider" - ], - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth Provider.", - "in": "path", - "name": "oauthProviderName", - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the OAuth Provider.", - "in": "path", - "name": "oauthProviderName", - "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 replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an OAuth Provider object.", - "tags": [ - "all", - "msgVpn", - "authenticationOauthProvider" - ], - "x-supportedInSempDirect": true - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Authorization Group objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Authorization Group objects.", - "tags": [ - "all", - "msgVpn", - "authorizationGroup" - ], - "x-supportedInSempDirect": false - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Authorization Group object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Group object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an Authorization Group object.", - "tags": [ - "all", - "msgVpn", - "authorizationGroup" - ], - "x-supportedInSempDirect": false - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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'.", - "in": "path", - "name": "authorizationGroupName", - "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 Authorization Group object.", - "tags": [ - "all", - "msgVpn", - "authorizationGroup" - ], - "x-supportedInSempDirect": false - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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'.", - "in": "path", - "name": "authorizationGroupName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Group object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an Authorization Group object.", - "tags": [ - "all", - "msgVpn", - "authorizationGroup" - ], - "x-supportedInSempDirect": false - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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'.", - "in": "path", - "name": "authorizationGroupName", - "required": true, - "type": "string" - }, - { - "description": "The Authorization Group object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Group object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an Authorization Group object.", - "tags": [ - "all", - "msgVpn", - "authorizationGroup" - ], - "x-supportedInSempDirect": false - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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'.", - "in": "path", - "name": "authorizationGroupName", - "required": true, - "type": "string" - }, - { - "description": "The Authorization Group object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroup" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Group object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an Authorization Group object.", - "tags": [ - "all", - "msgVpn", - "authorizationGroup" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/bridges": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Bridge objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Bridge objects.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Bridge object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridge" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Bridge object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Bridge object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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" - }, - { - "$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 Bridge object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Bridge object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Bridge object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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 Bridge object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridge" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Bridge object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Bridge object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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 Bridge object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridge" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Bridge object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Bridge object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - } - }, - "/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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Remote Message VPN objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Remote Message VPN objects.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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 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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Message VPN object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Remote Message VPN object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - } - }, - "/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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "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 Remote Message VPN object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Message VPN object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Remote Message VPN object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Message VPN object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Remote Message VPN object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Message VPN object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Remote Message VPN object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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" - }, - { - "$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 Remote Subscription objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Remote Subscription objects.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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 Remote Subscription object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Subscription object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Remote Subscription object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - } - }, - "/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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "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 Remote Subscription object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Remote Subscription object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Remote Subscription object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/whereQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNamesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Trusted Common Name objects.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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 Trusted Common Name object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Trusted Common Name object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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 expected trusted common name of the remote certificate.", - "in": "path", - "name": "tlsTrustedCommonName", - "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 Trusted Common Name object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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 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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trusted Common Name object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Trusted Common Name object.", - "tags": [ - "all", - "msgVpn", - "bridge" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/certMatchingRules": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRulesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Certificate Matching Rule objects.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Matching Rule object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Certificate Matching Rule object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "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 Matching Rule object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Certificate Matching Rule object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Matching Rule object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Certificate Matching Rule object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "description": "The Certificate Matching Rule object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRule" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Certificate Matching Rule object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFiltersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the rule.", - "in": "path", - "name": "ruleName", - "required": true, - "type": "string" - }, - { - "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/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Certificate Matching Rule Attribute Filter object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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/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", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Certificate Matching Rule Attribute Filter object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "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 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.", - "in": "path", - "name": "msgVpnName", - "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/MsgVpnCertMatchingRuleAttributeFilter" - } - }, - { - "$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/MsgVpnCertMatchingRuleAttributeFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Certificate Matching Rule Attribute Filter object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "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 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.", - "in": "path", - "name": "msgVpnName", - "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/MsgVpnCertMatchingRuleAttributeFilter" - } - }, - { - "$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 replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Certificate Matching Rule Attribute Filter object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Certificate Matching Rule Condition objects.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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.", - "in": "path", - "name": "msgVpnName", - "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/MsgVpnCertMatchingRuleCondition" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Certificate Matching Rule Condition object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "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 Matching Rule Condition object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "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", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Certificate Matching Rule Condition object.", - "tags": [ - "all", - "msgVpn", - "certMatchingRule" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/clientProfiles": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Client Profile objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientProfilesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Client Profile objects.", - "tags": [ - "all", - "msgVpn", - "clientProfile" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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 created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Client Profile object.", - "tags": [ - "all", - "msgVpn", - "clientProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}": { - "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", - "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/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 Profile object.", - "tags": [ - "all", - "msgVpn", - "clientProfile" - ], - "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", - "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" - }, - { - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Profile.", - "in": "path", - "name": "clientProfileName", - "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 replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Client Profile object.", - "tags": [ - "all", - "msgVpn", - "clientProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/clientUsernames": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Client Username objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientUsernamesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Client Username objects.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "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 created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Client Username object.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "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 Username object.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "required": true, - "type": "string" - }, - { - "$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": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Username object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Client Username object.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "x-supportedInSempDirect": false - }, - "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.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "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" - }, - { - "$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": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Client Username Attribute objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Client Username Attribute objects.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "required": true, - "type": "string" - }, - { - "description": "The Client Username Attribute object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttribute" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Username Attribute object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Client Username Attribute object.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "required": true, - "type": "string" - }, - { - "description": "The name of the Attribute.", - "in": "path", - "name": "attributeName", - "required": true, - "type": "string" - }, - { - "description": "The value of the Attribute.", - "in": "path", - "name": "attributeValue", - "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 Username Attribute object.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Client Username.", - "in": "path", - "name": "clientUsername", - "required": true, - "type": "string" - }, - { - "description": "The name of the Attribute.", - "in": "path", - "name": "attributeName", - "required": true, - "type": "string" - }, - { - "description": "The value of the Attribute.", - "in": "path", - "name": "attributeValue", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Client Username Attribute object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Client Username Attribute object.", - "tags": [ - "all", - "msgVpn", - "clientUsername" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Distributed Cache objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCachesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Distributed Cache objects.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Distributed Cache object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCache" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Distributed Cache object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Distributed Cache object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "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 Distributed Cache object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Distributed Cache object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Distributed Cache object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The Distributed Cache object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCache" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Distributed Cache object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Distributed Cache object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - }, - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The Distributed Cache object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCache" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Distributed Cache object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Distributed Cache object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Cache Cluster objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClustersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Cache Cluster objects.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Distributed Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The Cache Cluster object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Cluster object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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/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 Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Cluster object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The Cache Cluster object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Cluster object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The Cache Cluster object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Cluster object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "$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 Home Cache Cluster objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Home Cache Cluster objects.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The Home Cache Cluster object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Home Cache Cluster object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Home Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "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 request metadata.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Delete a Home Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The name of the remote Home Cache Cluster.", - "in": "path", - "name": "homeClusterName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Home Cache Cluster object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Home Cache Cluster object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The name of the remote Home Cache Cluster.", - "in": "path", - "name": "homeClusterName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Topic Prefix objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Topic Prefix objects.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - }, - "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.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Prefix object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Topic Prefix object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/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.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "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/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 Topic Prefix object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - }, - "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.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Prefix object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Topic Prefix object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "$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 Cache Instance objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstancesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Cache Instance objects.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The Cache Instance object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Instance object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Cache Instance object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The name of the Cache Instance.", - "in": "path", - "name": "instanceName", - "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 Cache Instance object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The name of the Cache Instance.", - "in": "path", - "name": "instanceName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Instance object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Cache Instance object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "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/MsgVpnDistributedCacheClusterInstance" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Instance object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Cache Instance object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "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/MsgVpnDistributedCacheClusterInstance" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Cache Instance object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Cache Instance object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "$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 Topic objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Topic objects.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The Topic object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Topic object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}": { - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The value of the Topic in the form a/b/c.", - "in": "path", - "name": "topic", - "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 Topic object.", - "tags": [ - "all", - "msgVpn", - "distributedCache" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The value of the Topic in the form a/b/c.", - "in": "path", - "name": "topic", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Topic 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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of DMR Bridge objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of DMR Bridge objects.", - "tags": [ - "all", - "msgVpn", - "dmrBridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The DMR Bridge object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridge" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The DMR Bridge object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a DMR Bridge object.", - "tags": [ - "all", - "msgVpn", - "dmrBridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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/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.", - "in": "path", - "name": "msgVpnName", - "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/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The DMR Bridge object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a DMR Bridge object.", - "tags": [ - "all", - "msgVpn", - "dmrBridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The DMR Bridge object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridge" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The DMR Bridge object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a DMR Bridge object.", - "tags": [ - "all", - "msgVpn", - "dmrBridge" - ], - "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", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - }, - { - "description": "The DMR Bridge object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridge" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The DMR Bridge object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnDmrBridgeResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a DMR Bridge object.", - "tags": [ - "all", - "msgVpn", - "dmrBridge" - ], - "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.4.", - "operationId": "getMsgVpnJndiConnectionFactories", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of JNDI Connection Factory objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoriesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of JNDI Connection Factory objects.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "createMsgVpnJndiConnectionFactory", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI Connection Factory object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$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" - } - }, - "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.4.", - "operationId": "deleteMsgVpnJndiConnectionFactory", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the JMS Connection Factory.", - "in": "path", - "name": "connectionFactoryName", - "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 Connection Factory object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "getMsgVpnJndiConnectionFactory", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the JMS Connection Factory.", - "in": "path", - "name": "connectionFactoryName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Connection Factory object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a JNDI Connection Factory object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "updateMsgVpnJndiConnectionFactory", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the JMS Connection Factory.", - "in": "path", - "name": "connectionFactoryName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI Connection Factory object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Connection Factory object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a JNDI Connection Factory object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "replaceMsgVpnJndiConnectionFactory", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the JMS Connection Factory.", - "in": "path", - "name": "connectionFactoryName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI Connection Factory object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactory" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Connection Factory object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a JNDI Connection Factory object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/jndiQueues": { - "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.4.", - "operationId": "getMsgVpnJndiQueues", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of JNDI Queue objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueuesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of JNDI Queue objects.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "createMsgVpnJndiQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI Queue object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueue" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Queue object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a JNDI Queue object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/jndiQueues/{queueName}": { - "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.4.", - "operationId": "deleteMsgVpnJndiQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Queue.", - "in": "path", - "name": "queueName", - "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 Queue object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "getMsgVpnJndiQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Queue object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a JNDI Queue object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "updateMsgVpnJndiQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI Queue object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueue" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Queue object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a JNDI Queue object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "replaceMsgVpnJndiQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI Queue object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueue" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Queue object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a JNDI Queue object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/jndiTopics": { - "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.4.", - "operationId": "getMsgVpnJndiTopics", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of JNDI Topic objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of JNDI Topic objects.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "createMsgVpnJndiTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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 created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a JNDI Topic object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/jndiTopics/{topicName}": { - "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.4.", - "operationId": "deleteMsgVpnJndiTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Topic.", - "in": "path", - "name": "topicName", - "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.4.", - "operationId": "getMsgVpnJndiTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Topic.", - "in": "path", - "name": "topicName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The JNDI Topic object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a JNDI Topic object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "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.4.", - "operationId": "updateMsgVpnJndiTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Topic.", - "in": "path", - "name": "topicName", - "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.4.", - "operationId": "replaceMsgVpnJndiTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The JNDI name of the JMS Topic.", - "in": "path", - "name": "topicName", - "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 replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnJndiTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a JNDI Topic object.", - "tags": [ - "all", - "msgVpn", - "jndi" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/mqttRetainCaches": { - "get": { - "description": "Get a list of MQTT Retain Cache objects.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\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": "getMsgVpnMqttRetainCaches", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of MQTT Retain Cache objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCachesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of MQTT Retain Cache objects.", - "tags": [ - "all", - "msgVpn", - "mqttRetainCache" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create an MQTT Retain 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\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|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": "createMsgVpnMqttRetainCache", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The MQTT Retain Cache object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCache" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Retain Cache object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an MQTT Retain Cache object.", - "tags": [ - "all", - "msgVpn", - "mqttRetainCache" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}": { - "delete": { - "description": "Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a 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.11.", - "operationId": "deleteMsgVpnMqttRetainCache", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the MQTT Retain Cache.", - "in": "path", - "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 an MQTT Retain Cache object.", - "tags": [ - "all", - "msgVpn", - "mqttRetainCache" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get an MQTT Retain Cache object.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\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": "getMsgVpnMqttRetainCache", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the MQTT Retain Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Retain Cache object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an MQTT Retain Cache object.", - "tags": [ - "all", - "msgVpn", - "mqttRetainCache" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|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": "updateMsgVpnMqttRetainCache", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the MQTT Retain Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The MQTT Retain Cache object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCache" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Retain Cache object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an MQTT Retain Cache object.", - "tags": [ - "all", - "msgVpn", - "mqttRetainCache" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|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": "replaceMsgVpnMqttRetainCache", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the MQTT Retain Cache.", - "in": "path", - "name": "cacheName", - "required": true, - "type": "string" - }, - { - "description": "The MQTT Retain Cache object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCache" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Retain Cache object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an MQTT Retain Cache object.", - "tags": [ - "all", - "msgVpn", - "mqttRetainCache" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4.", - "operationId": "getMsgVpnMqttSessions", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of MQTT Session objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of MQTT Session objects.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "createMsgVpnMqttSession", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The MQTT Session object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttSession" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Session object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an MQTT Session object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4.", - "operationId": "deleteMsgVpnMqttSession", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "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 MQTT Session object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "getMsgVpnMqttSession", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Session object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an MQTT Session object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "updateMsgVpnMqttSession", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The MQTT Session object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttSession" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Session object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an MQTT Session object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "replaceMsgVpnMqttSession", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The MQTT Session object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttSession" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The MQTT Session object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an MQTT Session object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4.", - "operationId": "getMsgVpnMqttSessionSubscriptions", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Subscription objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Subscription objects.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "createMsgVpnMqttSessionSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The Subscription object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscription" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscription object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Subscription object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4.", - "operationId": "deleteMsgVpnMqttSessionSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The MQTT subscription topic.", - "in": "path", - "name": "subscriptionTopic", - "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 Subscription object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "getMsgVpnMqttSessionSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The MQTT subscription topic.", - "in": "path", - "name": "subscriptionTopic", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscription object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Subscription object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "updateMsgVpnMqttSessionSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The MQTT subscription topic.", - "in": "path", - "name": "subscriptionTopic", - "required": true, - "type": "string" - }, - { - "description": "The Subscription object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscription" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscription object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Subscription object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "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.4.", - "operationId": "replaceMsgVpnMqttSessionSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", - "in": "path", - "name": "mqttSessionClientId", - "required": true, - "type": "string" - }, - { - "description": "The virtual router of the MQTT Session.", - "in": "path", - "name": "mqttSessionVirtualRouter", - "required": true, - "type": "string" - }, - { - "description": "The MQTT subscription topic.", - "in": "path", - "name": "subscriptionTopic", - "required": true, - "type": "string" - }, - { - "description": "The Subscription object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscription" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Subscription object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Subscription object.", - "tags": [ - "all", - "msgVpn", - "mqttSession" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/proxies": { - "get": { - "description": "Get a list of Proxy objects.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nmsgVpnName|x||\nproxyName|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": "getMsgVpnProxies", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Proxy objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnProxiesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Proxy objects.", - "tags": [ - "all", - "msgVpn", - "proxy" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Proxy 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\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nmsgVpnName|x|||x||\nproxyName|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": "createMsgVpnProxy", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Proxy object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnProxy" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Proxy object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnProxyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Proxy object.", - "tags": [ - "all", - "msgVpn", - "proxy" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/proxies/{proxyName}": { - "delete": { - "description": "Delete a Proxy object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\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": "deleteMsgVpnProxy", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the proxy.", - "in": "path", - "name": "proxyName", - "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 Proxy object.", - "tags": [ - "all", - "msgVpn", - "proxy" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Proxy object.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nmsgVpnName|x||\nproxyName|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": "getMsgVpnProxy", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the proxy.", - "in": "path", - "name": "proxyName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Proxy object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnProxyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Proxy object.", - "tags": [ - "all", - "msgVpn", - "proxy" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Proxy object. Any attribute missing from the request will be left unchanged.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x\nmsgVpnName|x||x||\nproxyName|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": "updateMsgVpnProxy", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the proxy.", - "in": "path", - "name": "proxyName", - "required": true, - "type": "string" - }, - { - "description": "The Proxy object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnProxy" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Proxy object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnProxyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Proxy object.", - "tags": [ - "all", - "msgVpn", - "proxy" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Proxy object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x\nmsgVpnName|x||x||\nproxyName|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": "replaceMsgVpnProxy", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the proxy.", - "in": "path", - "name": "proxyName", - "required": true, - "type": "string" - }, - { - "description": "The Proxy object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnProxy" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Proxy object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnProxyResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Proxy object.", - "tags": [ - "all", - "msgVpn", - "proxy" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/queueTemplates": { - "get": { - "description": "Get a list of Queue Template objects.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueTemplateName|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.14.", - "operationId": "getMsgVpnQueueTemplates", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Queue Template objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplatesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Queue Template objects.", - "tags": [ - "all", - "msgVpn", - "queueTemplate" - ], - "x-supportedInSempDirect": true - }, - "post": { - "description": "Create a Queue Template 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 Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueTemplateName|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:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|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.14.", - "operationId": "createMsgVpnQueueTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Template object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplate" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Template object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Queue Template object.", - "tags": [ - "all", - "msgVpn", - "queueTemplate" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}": { - "delete": { - "description": "Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\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": "deleteMsgVpnQueueTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue Template.", - "in": "path", - "name": "queueTemplateName", - "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 Queue Template object.", - "tags": [ - "all", - "msgVpn", - "queueTemplate" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get a Queue Template object.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueTemplateName|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": "getMsgVpnQueueTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue Template.", - "in": "path", - "name": "queueTemplateName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Template object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Queue Template object.", - "tags": [ - "all", - "msgVpn", - "queueTemplate" - ], - "x-supportedInSempDirect": true - }, - "patch": { - "description": "Update a Queue Template object. Any attribute missing from the request will be left unchanged.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueTemplateName|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:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|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.14.", - "operationId": "updateMsgVpnQueueTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue Template.", - "in": "path", - "name": "queueTemplateName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Template object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplate" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Template object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Queue Template object.", - "tags": [ - "all", - "msgVpn", - "queueTemplate" - ], - "x-supportedInSempDirect": true - }, - "put": { - "description": "Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueTemplateName|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:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|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.14.", - "operationId": "replaceMsgVpnQueueTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue Template.", - "in": "path", - "name": "queueTemplateName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Template object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplate" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Template object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Queue Template object.", - "tags": [ - "all", - "msgVpn", - "queueTemplate" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/queues": { - "get": { - "description": "Get a list of Queue objects.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\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.0.", - "operationId": "getMsgVpnQueues", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Queue objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueuesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Queue objects.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a 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\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueName|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:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|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.0.", - "operationId": "createMsgVpnQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Queue object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnQueue" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Queue object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/queues/{queueName}": { - "delete": { - "description": "Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\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": "deleteMsgVpnQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "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 Queue object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Queue object.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\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.0.", - "operationId": "getMsgVpnQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Queue object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Queue object. Any attribute missing from the request will be left unchanged.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nqueueName|x|x||\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||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:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|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.0.", - "operationId": "updateMsgVpnQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "description": "The Queue object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnQueue" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Queue object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nqueueName|x|x||\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||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:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|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.0.", - "operationId": "replaceMsgVpnQueue", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "description": "The Queue object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnQueue" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Queue object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions": { - "get": { - "description": "Get a list of Queue Subscription objects.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|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.0.", - "operationId": "getMsgVpnQueueSubscriptions", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Queue Subscription objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueSubscriptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Queue Subscription objects.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Queue 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\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueName|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.0.", - "operationId": "createMsgVpnQueueSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Subscription object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnQueueSubscription" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Subscription object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Queue Subscription object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}": { - "delete": { - "description": "Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\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": "deleteMsgVpnQueueSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "description": "The topic of the Subscription.", - "in": "path", - "name": "subscriptionTopic", - "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 Queue Subscription object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Queue Subscription object.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|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.0.", - "operationId": "getMsgVpnQueueSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Queue.", - "in": "path", - "name": "queueName", - "required": true, - "type": "string" - }, - { - "description": "The topic of the Subscription.", - "in": "path", - "name": "subscriptionTopic", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Subscription object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnQueueSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Queue Subscription object.", - "tags": [ - "all", - "msgVpn", - "queue" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/replayLogs": { - "get": { - "description": "Get a list of Replay Log objects.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|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.10.", - "operationId": "getMsgVpnReplayLogs", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Replay Log objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Replay Log objects.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Replay Log 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\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplayLogName|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.10.", - "operationId": "createMsgVpnReplayLog", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Replay Log object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnReplayLog" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replay Log object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Replay Log object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}": { - "delete": { - "description": "Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\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.10.", - "operationId": "deleteMsgVpnReplayLog", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "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 Replay Log object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Replay Log object.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|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.10.", - "operationId": "getMsgVpnReplayLog", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replay Log object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Replay Log object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Replay Log object. Any attribute missing from the request will be left unchanged.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplayLogName|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.10.", - "operationId": "updateMsgVpnReplayLog", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "required": true, - "type": "string" - }, - { - "description": "The Replay Log object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnReplayLog" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replay Log object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Replay Log object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplayLogName|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.10.", - "operationId": "replaceMsgVpnReplayLog", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "required": true, - "type": "string" - }, - { - "description": "The Replay Log object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnReplayLog" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replay Log object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Replay Log object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions": { - "get": { - "description": "Get a list of Topic Filter Subscription objects.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\ntopicFilterSubscription|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.27.", - "operationId": "getMsgVpnReplayLogTopicFilterSubscriptions", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Topic Filter Subscription objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Topic Filter Subscription objects.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Topic Filter 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\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplayLogName|x|||x\ntopicFilterSubscription|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.27.", - "operationId": "createMsgVpnReplayLogTopicFilterSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Filter Subscription object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Filter Subscription object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Topic Filter Subscription object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}": { - "delete": { - "description": "Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\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": "deleteMsgVpnReplayLogTopicFilterSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "required": true, - "type": "string" - }, - { - "description": "The topic of the Subscription.", - "in": "path", - "name": "topicFilterSubscription", - "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 Topic Filter Subscription object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Topic Filter Subscription object.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\ntopicFilterSubscription|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": "getMsgVpnReplayLogTopicFilterSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Replay Log.", - "in": "path", - "name": "replayLogName", - "required": true, - "type": "string" - }, - { - "description": "The topic of the Subscription.", - "in": "path", - "name": "topicFilterSubscription", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Filter Subscription object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Topic Filter Subscription object.", - "tags": [ - "all", - "msgVpn", - "replayLog" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4.", - "operationId": "getMsgVpnReplicatedTopics", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Replicated Topic objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopicsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Replicated Topic objects.", - "tags": [ - "all", - "msgVpn", - "replicatedTopic" - ], - "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.4.", - "operationId": "createMsgVpnReplicatedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Replicated Topic object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopic" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replicated Topic object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Replicated Topic object.", - "tags": [ - "all", - "msgVpn", - "replicatedTopic" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4.", - "operationId": "deleteMsgVpnReplicatedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", - "in": "path", - "name": "replicatedTopic", - "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 Replicated Topic object.", - "tags": [ - "all", - "msgVpn", - "replicatedTopic" - ], - "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.4.", - "operationId": "getMsgVpnReplicatedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", - "in": "path", - "name": "replicatedTopic", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replicated Topic object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Replicated Topic object.", - "tags": [ - "all", - "msgVpn", - "replicatedTopic" - ], - "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.4.", - "operationId": "updateMsgVpnReplicatedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", - "in": "path", - "name": "replicatedTopic", - "required": true, - "type": "string" - }, - { - "description": "The Replicated Topic object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopic" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replicated Topic object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Replicated Topic object.", - "tags": [ - "all", - "msgVpn", - "replicatedTopic" - ], - "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.4.", - "operationId": "replaceMsgVpnReplicatedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", - "in": "path", - "name": "replicatedTopic", - "required": true, - "type": "string" - }, - { - "description": "The Replicated Topic object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopic" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Replicated Topic object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Replicated Topic object.", - "tags": [ - "all", - "msgVpn", - "replicatedTopic" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints": { - "get": { - "description": "Get a list of REST Delivery Point objects.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestDeliveryPointName|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": "getMsgVpnRestDeliveryPoints", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of REST Delivery Point objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of REST Delivery Point objects.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a REST Delivery Point 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 REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nrestDeliveryPointName|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": "createMsgVpnRestDeliveryPoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The REST Delivery Point object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPoint" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Delivery Point object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a REST Delivery Point object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}": { - "delete": { - "description": "Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\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": "deleteMsgVpnRestDeliveryPoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "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 REST Delivery Point object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a REST Delivery Point object.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestDeliveryPointName|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": "getMsgVpnRestDeliveryPoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Delivery Point object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a REST Delivery Point object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nclientProfileName||||x\nmsgVpnName|x||x|\nrestDeliveryPointName|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": "updateMsgVpnRestDeliveryPoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The REST Delivery Point object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPoint" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Delivery Point object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a REST Delivery Point object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nclientProfileName||||x\nmsgVpnName|x||x|\nrestDeliveryPointName|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": "replaceMsgVpnRestDeliveryPoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The REST Delivery Point object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPoint" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Delivery Point object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a REST Delivery Point object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings": { - "get": { - "description": "Get a list of Queue Binding objects.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|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": "getMsgVpnRestDeliveryPointQueueBindings", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Queue Binding objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Queue Binding objects.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "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 for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueBindingName|x|x|x|\nrestDeliveryPointName|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": "createMsgVpnRestDeliveryPointQueueBinding", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Binding object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Binding object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Queue Binding object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}": { - "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 for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\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": "deleteMsgVpnRestDeliveryPointQueueBinding", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "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 Queue Binding object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Queue Binding object.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|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": "getMsgVpnRestDeliveryPointQueueBinding", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Binding object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Queue Binding object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Queue Binding object. Any attribute missing from the request will be left unchanged.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueBindingName|x|x|\nrestDeliveryPointName|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": "updateMsgVpnRestDeliveryPointQueueBinding", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Binding object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Binding object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Queue Binding object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "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 for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueBindingName|x|x|\nrestDeliveryPointName|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": "replaceMsgVpnRestDeliveryPointQueueBinding", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The Queue Binding object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Queue Binding object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Queue Binding object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/protectedRequestHeaders": { - "get": { - "description": "Get a list of Protected Request Header objects.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nheaderName|x||\nheaderValue||x|x\nmsgVpnName|x||\nqueueBindingName|x||\nrestDeliveryPointName|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.30.", - "operationId": "getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaders", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Protected Request Header objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeadersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Protected Request Header objects.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "post": { - "description": "Create a Protected Request Header 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 protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|x|||\nheaderValue|||||x|x\nmsgVpnName|x|||x||\nqueueBindingName|x|||x||\nrestDeliveryPointName|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.30.", - "operationId": "createMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The Protected Request Header object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Protected Request Header object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Protected Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/protectedRequestHeaders/{headerName}": { - "delete": { - "description": "Delete a Protected Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\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.30.", - "operationId": "deleteMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the protected HTTP request header.", - "in": "path", - "name": "headerName", - "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 Protected Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get a Protected Request Header object.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nheaderName|x||\nheaderValue||x|x\nmsgVpnName|x||\nqueueBindingName|x||\nrestDeliveryPointName|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.30.", - "operationId": "getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the protected HTTP request header.", - "in": "path", - "name": "headerName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Protected Request Header object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Protected Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "patch": { - "description": "Update a Protected Request Header object. Any attribute missing from the request will be left unchanged.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|||\nheaderValue||||x|x\nmsgVpnName|x||x||\nqueueBindingName|x||x||\nrestDeliveryPointName|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.30.", - "operationId": "updateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the protected HTTP request header.", - "in": "path", - "name": "headerName", - "required": true, - "type": "string" - }, - { - "description": "The Protected Request Header object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Protected Request Header object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Protected Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "put": { - "description": "Replace a Protected Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|||\nheaderValue||||x|x\nmsgVpnName|x||x||\nqueueBindingName|x||x||\nrestDeliveryPointName|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.30.", - "operationId": "replaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the protected HTTP request header.", - "in": "path", - "name": "headerName", - "required": true, - "type": "string" - }, - { - "description": "The Protected Request Header object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Protected Request Header object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Protected Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders": { - "get": { - "description": "Get a list of Request Header objects.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying\n:---|:---:\nheaderName|x\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|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.23.", - "operationId": "getMsgVpnRestDeliveryPointQueueBindingRequestHeaders", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Request Header objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Request Header objects.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "post": { - "description": "Create a Request Header 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 request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nheaderName|x|x|x|\nmsgVpnName|x|||x\nqueueBindingName|x|||x\nrestDeliveryPointName|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.23.", - "operationId": "createMsgVpnRestDeliveryPointQueueBindingRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The Request Header object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Request Header object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}": { - "delete": { - "description": "Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA request header to be added to the HTTP request.\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.23.", - "operationId": "deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the HTTP request header.", - "in": "path", - "name": "headerName", - "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 Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get a Request Header object.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying\n:---|:---:\nheaderName|x\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|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.23.", - "operationId": "getMsgVpnRestDeliveryPointQueueBindingRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the HTTP request header.", - "in": "path", - "name": "headerName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Request Header object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "patch": { - "description": "Update a Request Header object. Any attribute missing from the request will be left unchanged.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nheaderName|x|x|\nmsgVpnName|x||x\nqueueBindingName|x||x\nrestDeliveryPointName|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.23.", - "operationId": "updateMsgVpnRestDeliveryPointQueueBindingRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the HTTP request header.", - "in": "path", - "name": "headerName", - "required": true, - "type": "string" - }, - { - "description": "The Request Header object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Request Header object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "put": { - "description": "Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nheaderName|x|x|\nmsgVpnName|x||x\nqueueBindingName|x||x\nrestDeliveryPointName|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.23.", - "operationId": "replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of a queue in the Message VPN.", - "in": "path", - "name": "queueBindingName", - "required": true, - "type": "string" - }, - { - "description": "The name of the HTTP request header.", - "in": "path", - "name": "headerName", - "required": true, - "type": "string" - }, - { - "description": "The Request Header object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Request Header object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Request Header object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers": { - "get": { - "description": "Get a list of REST Consumer objects.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationHttpBasicPassword||x|x\nauthenticationHttpHeaderValue||x|x\nauthenticationOauthClientSecret||x|x\nauthenticationOauthJwtSecretKey||x|x\nmsgVpnName|x||\nrestConsumerName|x||\nrestDeliveryPointName|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": "getMsgVpnRestDeliveryPointRestConsumers", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of REST Consumer objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of REST Consumer objects.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a REST Consumer 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\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationHttpBasicPassword|||||x|x\nauthenticationHttpHeaderValue|||||x|x\nauthenticationOauthClientSecret|||||x|x\nauthenticationOauthJwtSecretKey|||||x|x\nmsgVpnName|x|||x||\nrestConsumerName|x|x|x|||\nrestDeliveryPointName|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:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort\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": "createMsgVpnRestDeliveryPointRestConsumer", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The REST Consumer object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Consumer object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a REST Consumer object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}": { - "delete": { - "description": "Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a 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": "deleteMsgVpnRestDeliveryPointRestConsumer", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "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 REST Consumer object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a REST Consumer object.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationHttpBasicPassword||x|x\nauthenticationHttpHeaderValue||x|x\nauthenticationOauthClientSecret||x|x\nauthenticationOauthJwtSecretKey||x|x\nmsgVpnName|x||\nrestConsumerName|x||\nrestDeliveryPointName|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": "getMsgVpnRestDeliveryPointRestConsumer", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Consumer object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a REST Consumer object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a REST Consumer object. Any attribute missing from the request will be left unchanged.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||||x||x\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationHttpBasicPassword||||x|x|x\nauthenticationHttpBasicUsername|||||x|\nauthenticationHttpHeaderValue||||x||x\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationOauthClientTokenExpiryDefault|||||x|\nauthenticationOauthJwtSecretKey||||x|x|x\nauthenticationOauthJwtTokenEndpoint|||||x|\nauthenticationOauthJwtTokenExpiryDefault|||||x|\nauthenticationScheme|||||x|\nmsgVpnName|x||x|||\noutgoingConnectionCount|||||x|\nremoteHost|||||x|\nremotePort|||||x|\nrestConsumerName|x|x||||\nrestDeliveryPointName|x||x|||\ntlsCipherSuiteList|||||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:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort\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": "updateMsgVpnRestDeliveryPointRestConsumer", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "required": true, - "type": "string" - }, - { - "description": "The REST Consumer object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Consumer object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a REST Consumer object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||||x||x\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationHttpBasicPassword||||x|x|x\nauthenticationHttpBasicUsername|||||x|\nauthenticationHttpHeaderValue||||x||x\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationOauthClientTokenExpiryDefault|||||x|\nauthenticationOauthJwtSecretKey||||x|x|x\nauthenticationOauthJwtTokenEndpoint|||||x|\nauthenticationOauthJwtTokenExpiryDefault|||||x|\nauthenticationScheme|||||x|\nmsgVpnName|x||x|||\noutgoingConnectionCount|||||x|\nremoteHost|||||x|\nremotePort|||||x|\nrestConsumerName|x|x||||\nrestDeliveryPointName|x||x|||\ntlsCipherSuiteList|||||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:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort\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": "replaceMsgVpnRestDeliveryPointRestConsumer", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "required": true, - "type": "string" - }, - { - "description": "The REST Consumer object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The REST Consumer object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a REST Consumer object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims": { - "get": { - "description": "Get a list of Claim objects.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthJwtClaimName|x\nrestConsumerName|x\nrestDeliveryPointName|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.21.", - "operationId": "getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Claim objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Claim objects.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "post": { - "description": "Create a 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\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\noauthJwtClaimName|x|x|x|\noauthJwtClaimValue||x|x|\nrestConsumerName|x|||x\nrestDeliveryPointName|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.21.", - "operationId": "createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "required": true, - "type": "string" - }, - { - "description": "The Claim object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Claim object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Claim object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}": { - "delete": { - "description": "Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\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.21.", - "operationId": "deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "required": true, - "type": "string" - }, - { - "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", - "in": "path", - "name": "oauthJwtClaimName", - "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 Claim object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get a Claim object.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthJwtClaimName|x\nrestConsumerName|x\nrestDeliveryPointName|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.21.", - "operationId": "getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "required": true, - "type": "string" - }, - { - "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", - "in": "path", - "name": "oauthJwtClaimName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Claim object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Claim object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames": { - "get": { - "deprecated": true, - "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\nrestConsumerName|x|x\nrestDeliveryPointName|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.17. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "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 Trusted Common Name objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Trusted Common Name objects.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "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 REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|x\nrestConsumerName|x|||x|x\nrestDeliveryPointName|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.17. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "required": true, - "type": "string" - }, - { - "description": "The Trusted Common Name object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Trusted Common Name object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/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 REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\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.17. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "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" - } - ], - "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 Trusted Common Name object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - }, - "get": { - "deprecated": true, - "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\nrestConsumerName|x|x\nrestDeliveryPointName|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.17. Common Name validation has been replaced by Server Certificate Name validation.", - "operationId": "getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Delivery Point.", - "in": "path", - "name": "restDeliveryPointName", - "required": true, - "type": "string" - }, - { - "description": "The name of the REST Consumer.", - "in": "path", - "name": "restConsumerName", - "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" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trusted Common Name object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Trusted Common Name object.", - "tags": [ - "all", - "msgVpn", - "restDeliveryPoint" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/sequencedTopics": { - "get": { - "description": "Get a list of Sequenced Topic objects.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsequencedTopic|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": "getMsgVpnSequencedTopics", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Sequenced Topic objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnSequencedTopicsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Sequenced Topic objects.", - "tags": [ - "all", - "msgVpn" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Sequenced 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\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nsequencedTopic|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": "createMsgVpnSequencedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Sequenced Topic object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnSequencedTopic" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Sequenced Topic object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnSequencedTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Sequenced Topic object.", - "tags": [ - "all", - "msgVpn" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}": { - "delete": { - "description": "Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\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": "deleteMsgVpnSequencedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "Topic for applying sequence numbers.", - "in": "path", - "name": "sequencedTopic", - "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 Sequenced Topic object.", - "tags": [ - "all", - "msgVpn" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Sequenced Topic object.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsequencedTopic|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": "getMsgVpnSequencedTopic", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "Topic for applying sequence numbers.", - "in": "path", - "name": "sequencedTopic", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Sequenced Topic object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnSequencedTopicResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Sequenced Topic object.", - "tags": [ - "all", - "msgVpn" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles": { - "get": { - "description": "Get a list of Telemetry Profile objects.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|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.31.", - "operationId": "getMsgVpnTelemetryProfiles", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Telemetry Profile objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfilesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Telemetry Profile objects.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Telemetry 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\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntelemetryProfileName|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:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|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.31.", - "operationId": "createMsgVpnTelemetryProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Telemetry Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Telemetry Profile object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Telemetry Profile object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}": { - "delete": { - "description": "Delete a Telemetry Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\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.31.", - "operationId": "deleteMsgVpnTelemetryProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "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 Telemetry Profile object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Telemetry Profile object.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|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.31.", - "operationId": "getMsgVpnTelemetryProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Telemetry Profile object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Telemetry Profile object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Telemetry Profile object. Any attribute missing from the request will be left unchanged.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|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:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|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.31.", - "operationId": "updateMsgVpnTelemetryProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Telemetry Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Telemetry Profile object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Telemetry Profile object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Telemetry Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|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:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|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.31.", - "operationId": "replaceMsgVpnTelemetryProfile", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Telemetry Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Telemetry Profile object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Telemetry Profile object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/receiverAclConnectExceptions": { - "get": { - "description": "Get a list of Receiver ACL Connect Exception objects.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreceiverAclConnectExceptionAddress|x\ntelemetryProfileName|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.31.", - "operationId": "getMsgVpnTelemetryProfileReceiverAclConnectExceptions", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Receiver ACL Connect Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Receiver ACL Connect Exception objects.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Receiver ACL 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 Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreceiverAclConnectExceptionAddress|x|x|x|\ntelemetryProfileName|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.31.", - "operationId": "createMsgVpnTelemetryProfileReceiverAclConnectException", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Receiver ACL Connect Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Receiver ACL Connect Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Receiver ACL Connect Exception object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/receiverAclConnectExceptions/{receiverAclConnectExceptionAddress}": { - "delete": { - "description": "Delete a Receiver ACL Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. 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.31.", - "operationId": "deleteMsgVpnTelemetryProfileReceiverAclConnectException", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "description": "The IP address/netmask of the receiver connect exception in CIDR form.", - "in": "path", - "name": "receiverAclConnectExceptionAddress", - "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 Receiver ACL Connect Exception object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Receiver ACL Connect Exception object.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreceiverAclConnectExceptionAddress|x\ntelemetryProfileName|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.31.", - "operationId": "getMsgVpnTelemetryProfileReceiverAclConnectException", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "description": "The IP address/netmask of the receiver connect exception in CIDR form.", - "in": "path", - "name": "receiverAclConnectExceptionAddress", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Receiver ACL Connect Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileReceiverAclConnectExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Receiver ACL Connect Exception object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters": { - "get": { - "description": "Get a list of Trace Filter objects.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|x\ntraceFilterName|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.31.", - "operationId": "getMsgVpnTelemetryProfileTraceFilters", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Trace Filter objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFiltersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Trace Filter objects.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Trace 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 Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntelemetryProfileName|x|||x\ntraceFilterName|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.31.", - "operationId": "createMsgVpnTelemetryProfileTraceFilter", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Trace Filter object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilter" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trace Filter object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Trace Filter object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}": { - "delete": { - "description": "Delete a Trace Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the 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.31.", - "operationId": "deleteMsgVpnTelemetryProfileTraceFilter", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "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 Trace Filter object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Trace Filter object.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|x\ntraceFilterName|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.31.", - "operationId": "getMsgVpnTelemetryProfileTraceFilter", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trace Filter object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Trace Filter object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Trace Filter object. Any attribute missing from the request will be left unchanged.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|x||x\ntraceFilterName|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.31.", - "operationId": "updateMsgVpnTelemetryProfileTraceFilter", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "required": true, - "type": "string" - }, - { - "description": "The Trace Filter object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilter" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trace Filter object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Trace Filter object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Trace Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|x||x\ntraceFilterName|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.31.", - "operationId": "replaceMsgVpnTelemetryProfileTraceFilter", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "required": true, - "type": "string" - }, - { - "description": "The Trace Filter object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilter" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Trace Filter object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Trace Filter object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}/subscriptions": { - "get": { - "description": "Get a list of Telemetry Trace Filter Subscription objects.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsubscription|x\nsubscriptionSyntax|x\ntelemetryProfileName|x\ntraceFilterName|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.31.", - "operationId": "getMsgVpnTelemetryProfileTraceFilterSubscriptions", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Telemetry Trace Filter Subscription objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscriptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Telemetry Trace Filter Subscription objects.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Telemetry Trace Filter 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\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nsubscription|x|x|x|\nsubscriptionSyntax|x|x|x|\ntelemetryProfileName|x|||x\ntraceFilterName|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.31.", - "operationId": "createMsgVpnTelemetryProfileTraceFilterSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "required": true, - "type": "string" - }, - { - "description": "The Telemetry Trace Filter Subscription object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscription" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Telemetry Trace Filter Subscription object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Telemetry Trace Filter Subscription object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}/subscriptions/{subscription},{subscriptionSyntax}": { - "delete": { - "description": "Delete a Telemetry Trace Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\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.31.", - "operationId": "deleteMsgVpnTelemetryProfileTraceFilterSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "required": true, - "type": "string" - }, - { - "description": "Messages matching this subscription will follow this filter's configuration.", - "in": "path", - "name": "subscription", - "required": true, - "type": "string" - }, - { - "description": "The syntax of the trace filter subscription.", - "in": "path", - "name": "subscriptionSyntax", - "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 Telemetry Trace Filter Subscription object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Telemetry Trace Filter Subscription object.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsubscription|x\nsubscriptionSyntax|x\ntelemetryProfileName|x\ntraceFilterName|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.31.", - "operationId": "getMsgVpnTelemetryProfileTraceFilterSubscription", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Telemetry Profile.", - "in": "path", - "name": "telemetryProfileName", - "required": true, - "type": "string" - }, - { - "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\".", - "in": "path", - "name": "traceFilterName", - "required": true, - "type": "string" - }, - { - "description": "Messages matching this subscription will follow this filter's configuration.", - "in": "path", - "name": "subscription", - "required": true, - "type": "string" - }, - { - "description": "The syntax of the trace filter subscription.", - "in": "path", - "name": "subscriptionSyntax", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Telemetry Trace Filter Subscription object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTelemetryProfileTraceFilterSubscriptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Telemetry Trace Filter Subscription object.", - "tags": [ - "all", - "msgVpn", - "telemetryProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/msgVpns/{msgVpnName}/topicEndpointTemplates": { - "get": { - "description": "Get a list of Topic Endpoint Template objects.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointTemplateName|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.14.", - "operationId": "getMsgVpnTopicEndpointTemplates", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Topic Endpoint Template objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplatesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Topic Endpoint Template objects.", - "tags": [ - "all", - "msgVpn", - "topicEndpointTemplate" - ], - "x-supportedInSempDirect": true - }, - "post": { - "description": "Create a Topic Endpoint Template 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 Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicEndpointTemplateName|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:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|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.14.", - "operationId": "createMsgVpnTopicEndpointTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Endpoint Template object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint Template object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Topic Endpoint Template object.", - "tags": [ - "all", - "msgVpn", - "topicEndpointTemplate" - ], - "x-supportedInSempDirect": true - } - }, - "/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}": { - "delete": { - "description": "Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\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": "deleteMsgVpnTopicEndpointTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint Template.", - "in": "path", - "name": "topicEndpointTemplateName", - "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 Topic Endpoint Template object.", - "tags": [ - "all", - "msgVpn", - "topicEndpointTemplate" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get a Topic Endpoint Template object.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointTemplateName|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": "getMsgVpnTopicEndpointTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint Template.", - "in": "path", - "name": "topicEndpointTemplateName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint Template object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Topic Endpoint Template object.", - "tags": [ - "all", - "msgVpn", - "topicEndpointTemplate" - ], - "x-supportedInSempDirect": true - }, - "patch": { - "description": "Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicEndpointTemplateName|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:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|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.14.", - "operationId": "updateMsgVpnTopicEndpointTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint Template.", - "in": "path", - "name": "topicEndpointTemplateName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Endpoint Template object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint Template object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Topic Endpoint Template object.", - "tags": [ - "all", - "msgVpn", - "topicEndpointTemplate" - ], - "x-supportedInSempDirect": true - }, - "put": { - "description": "Replace a Topic Endpoint Template 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 Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicEndpointTemplateName|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:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|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.14.", - "operationId": "replaceMsgVpnTopicEndpointTemplate", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint Template.", - "in": "path", - "name": "topicEndpointTemplateName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Endpoint Template object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint Template object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Topic Endpoint Template object.", - "tags": [ - "all", - "msgVpn", - "topicEndpointTemplate" - ], - "x-supportedInSempDirect": true - } - }, - "/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.4.", - "operationId": "getMsgVpnTopicEndpoints", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Topic Endpoint objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Topic Endpoint objects.", - "tags": [ - "all", - "msgVpn", - "topicEndpoint" - ], - "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.4.", - "operationId": "createMsgVpnTopicEndpoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Endpoint object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpoint" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Topic Endpoint object.", - "tags": [ - "all", - "msgVpn", - "topicEndpoint" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4.", - "operationId": "deleteMsgVpnTopicEndpoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint.", - "in": "path", - "name": "topicEndpointName", - "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 Topic Endpoint object.", - "tags": [ - "all", - "msgVpn", - "topicEndpoint" - ], - "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.4.", - "operationId": "getMsgVpnTopicEndpoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint.", - "in": "path", - "name": "topicEndpointName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Topic Endpoint object.", - "tags": [ - "all", - "msgVpn", - "topicEndpoint" - ], - "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.4.", - "operationId": "updateMsgVpnTopicEndpoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint.", - "in": "path", - "name": "topicEndpointName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Endpoint object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpoint" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Topic Endpoint object.", - "tags": [ - "all", - "msgVpn", - "topicEndpoint" - ], - "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.4.", - "operationId": "replaceMsgVpnTopicEndpoint", - "parameters": [ - { - "description": "The name of the Message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The name of the Topic Endpoint.", - "in": "path", - "name": "topicEndpointName", - "required": true, - "type": "string" - }, - { - "description": "The Topic Endpoint object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpoint" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Topic Endpoint object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/MsgVpnTopicEndpointResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Topic Endpoint object.", - "tags": [ - "all", - "msgVpn", - "topicEndpoint" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles": { - "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\noauthProfileName|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.24.", - "operationId": "getOauthProfiles", - "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 OAuth Profile objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfilesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of OAuth Profile objects.", - "tags": [ - "all", - "oauthProfile" - ], - "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 via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\noauthProfileName|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.24.", - "operationId": "createOauthProfile", - "parameters": [ - { - "description": "The OAuth Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OAuth Profile object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an OAuth Profile object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}": { - "delete": { - "description": "Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates 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 \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", - "operationId": "deleteOauthProfile", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "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\noauthProfileName|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.24.", - "operationId": "getOauthProfile", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OAuth Profile object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an OAuth Profile object.", - "tags": [ - "all", - "oauthProfile" - ], - "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|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret|||x|x\noauthProfileName|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. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", - "operationId": "updateOauthProfile", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The OAuth Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfile" - } - }, - { - "$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/OauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an OAuth Profile object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "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|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret|||x|x\noauthProfileName|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. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", - "operationId": "replaceOauthProfile", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The OAuth Profile object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfile" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The OAuth Profile object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an OAuth Profile object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/accessLevelGroups": { - "get": { - "description": "Get a list of Group Access Level objects.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileAccessLevelGroups", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Group Access Level objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Group Access Level objects.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Group Access Level 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 name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ngroupName|x|x|x|\noauthProfileName|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. An access scope/level of \"global/admin\" is required to create access level groups with a global access level greater than \"none\". Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", - "operationId": "createOauthProfileAccessLevelGroup", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Group Access Level object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroup" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Group Access Level object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Group Access Level object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}": { - "delete": { - "description": "Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. An access scope/level of \"global/admin\" is required to delete access level groups with a global access level greater than \"none\".\n\nThis has been available since 2.24.", - "operationId": "deleteOauthProfileAccessLevelGroup", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "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 Group Access Level object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Group Access Level object.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileAccessLevelGroup", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Group Access Level object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Group Access Level object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Group Access Level object. Any attribute missing from the request will be left unchanged.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x|x|\noauthProfileName|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. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", - "operationId": "updateOauthProfileAccessLevelGroup", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "description": "The Group Access Level object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroup" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Group Access Level object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Group Access Level object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x|x|\noauthProfileName|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. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", - "operationId": "replaceOauthProfileAccessLevelGroup", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "description": "The Group Access Level object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroup" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Group Access Level object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Group Access Level object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions": { - "get": { - "description": "Get a list of Message VPN Access-Level Exception objects.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\nmsgVpnName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Message VPN Access-Level Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Message VPN Access-Level Exception objects.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Message VPN Access-Level 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 via config-sync.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||x\nmsgVpnName|x|x|x|\noauthProfileName|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.24.", - "operationId": "createOauthProfileAccessLevelGroupMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN Access-Level Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN Access-Level Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}": { - "delete": { - "description": "Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPN access-level exceptions for members of this group.\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.24.", - "operationId": "deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "description": "The name of the message VPN.", - "in": "path", - "name": "msgVpnName", - "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 Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Message VPN Access-Level Exception object.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\nmsgVpnName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileAccessLevelGroupMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "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 Message VPN Access-Level Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x||x\nmsgVpnName|x|x|\noauthProfileName|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.24.", - "operationId": "updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "description": "The name of the message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN Access-Level Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x||x\nmsgVpnName|x|x|\noauthProfileName|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.24.", - "operationId": "replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the group.", - "in": "path", - "name": "groupName", - "required": true, - "type": "string" - }, - { - "description": "The name of the message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN Access-Level Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/clientAllowedHosts": { - "get": { - "description": "Get a list of Allowed Host Value objects.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying\n:---|:---:\nallowedHost|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileClientAllowedHosts", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Allowed Host Value objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAllowedHostsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Allowed Host Value objects.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create an Allowed Host Value 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 valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nallowedHost|x|x|x|\noauthProfileName|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.24.", - "operationId": "createOauthProfileClientAllowedHost", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Allowed Host Value object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileClientAllowedHost" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Allowed Host Value object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAllowedHostResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an Allowed Host Value object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}": { - "delete": { - "description": "Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA valid hostname for this broker in OAuth redirects.\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.24.", - "operationId": "deleteOauthProfileClientAllowedHost", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "An allowed value for the Host header.", - "in": "path", - "name": "allowedHost", - "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 Allowed Host Value object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get an Allowed Host Value object.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying\n:---|:---:\nallowedHost|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileClientAllowedHost", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "An allowed value for the Host header.", - "in": "path", - "name": "allowedHost", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Allowed Host Value object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAllowedHostResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an Allowed Host Value object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters": { - "get": { - "description": "Get a list of Authorization Parameter objects.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nauthorizationParameterName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileClientAuthorizationParameters", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Authorization Parameter objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParametersResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Authorization Parameter objects.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create an Authorization Parameter 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\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|x|x|\noauthProfileName|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.24.", - "operationId": "createOauthProfileClientAuthorizationParameter", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Authorization Parameter object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Parameter object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create an Authorization Parameter object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}": { - "delete": { - "description": "Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\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.24.", - "operationId": "deleteOauthProfileClientAuthorizationParameter", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the authorization parameter.", - "in": "path", - "name": "authorizationParameterName", - "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 Authorization Parameter object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get an Authorization Parameter object.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nauthorizationParameterName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileClientAuthorizationParameter", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the authorization parameter.", - "in": "path", - "name": "authorizationParameterName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Parameter object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get an Authorization Parameter object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nauthorizationParameterName|x|x|\noauthProfileName|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.24.", - "operationId": "updateOauthProfileClientAuthorizationParameter", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the authorization parameter.", - "in": "path", - "name": "authorizationParameterName", - "required": true, - "type": "string" - }, - { - "description": "The Authorization Parameter object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Parameter object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update an Authorization Parameter object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nauthorizationParameterName|x|x|\noauthProfileName|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.24.", - "operationId": "replaceOauthProfileClientAuthorizationParameter", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the authorization parameter.", - "in": "path", - "name": "authorizationParameterName", - "required": true, - "type": "string" - }, - { - "description": "The Authorization Parameter object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Authorization Parameter object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace an Authorization Parameter object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/clientRequiredClaims": { - "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\noauthProfileName|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.24.", - "operationId": "getOauthProfileClientRequiredClaims", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Required Claim objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientRequiredClaimsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Required Claim objects.", - "tags": [ - "all", - "oauthProfile" - ], - "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 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|\noauthProfileName|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.24.", - "operationId": "createOauthProfileClientRequiredClaim", - "parameters": [ - { - "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/OauthProfileClientRequiredClaim" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Required Claim object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { - "delete": { - "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates 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 \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", - "operationId": "deleteOauthProfileClientRequiredClaim", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ID token claim to verify.", - "in": "path", - "name": "clientRequiredClaimName", - "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 Required Claim object.", - "tags": [ - "all", - "oauthProfile" - ], - "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\noauthProfileName|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.24.", - "operationId": "getOauthProfileClientRequiredClaim", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the ID token claim to verify.", - "in": "path", - "name": "clientRequiredClaimName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileClientRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Required Claim object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions": { - "get": { - "description": "Get a list of Message VPN Access-Level Exception objects.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileDefaultMsgVpnAccessLevelExceptions", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Message VPN Access-Level Exception objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Message VPN Access-Level Exception objects.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "post": { - "description": "Create a Message VPN Access-Level 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 via config-sync.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|x|x|\noauthProfileName|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.24.", - "operationId": "createOauthProfileDefaultMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN Access-Level Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN Access-Level Exception object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}": { - "delete": { - "description": "Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nDefault message VPN access-level exceptions.\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.24.", - "operationId": "deleteOauthProfileDefaultMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the message VPN.", - "in": "path", - "name": "msgVpnName", - "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 Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "get": { - "description": "Get a Message VPN Access-Level Exception object.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|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.24.", - "operationId": "getOauthProfileDefaultMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "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 Message VPN Access-Level Exception object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "patch": { - "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x|x|\noauthProfileName|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.24.", - "operationId": "updateOauthProfileDefaultMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN Access-Level Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - }, - "put": { - "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x|x|\noauthProfileName|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.24.", - "operationId": "replaceOauthProfileDefaultMsgVpnAccessLevelException", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the message VPN.", - "in": "path", - "name": "msgVpnName", - "required": true, - "type": "string" - }, - { - "description": "The Message VPN Access-Level Exception object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Message VPN Access-Level Exception object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{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:---|:---:\noauthProfileName|x\nresourceServerRequiredClaimName|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.24.", - "operationId": "getOauthProfileResourceServerRequiredClaims", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "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" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The list of Required Claim objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimsResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Required Claim objects.", - "tags": [ - "all", - "oauthProfile" - ], - "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 via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\noauthProfileName|x|||x\nresourceServerRequiredClaimName|x|x|x|\nresourceServerRequiredClaimValue||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.24.", - "operationId": "createOauthProfileResourceServerRequiredClaim", - "parameters": [ - { - "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/OauthProfileResourceServerRequiredClaim" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Required Claim object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}": { - "delete": { - "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates 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 \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", - "operationId": "deleteOauthProfileResourceServerRequiredClaim", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the access token claim to verify.", - "in": "path", - "name": "resourceServerRequiredClaimName", - "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 Required Claim object.", - "tags": [ - "all", - "oauthProfile" - ], - "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:---|:---:\noauthProfileName|x\nresourceServerRequiredClaimName|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.24.", - "operationId": "getOauthProfileResourceServerRequiredClaim", - "parameters": [ - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The name of the access token claim to verify.", - "in": "path", - "name": "resourceServerRequiredClaimName", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Required Claim object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Required Claim object.", - "tags": [ - "all", - "oauthProfile" - ], - "x-supportedInSempDirect": false - } - }, - "/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.4. /systemInformation was replaced by /about/api.", - "operationId": "getSystemInformation", - "parameters": [ - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The System Information object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/SystemInformationResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a System Information object.", - "tags": [ - "all", - "systemInformation" - ], - "x-supportedInSempDirect": false - } - }, - "/virtualHostnames": { - "get": { - "description": "Get a list of Virtual Hostname objects.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying\n:---|:---:\nvirtualHostname|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.17.", - "operationId": "getVirtualHostnames", - "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 Virtual Hostname objects' attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/VirtualHostnamesResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a list of Virtual Hostname objects.", - "tags": [ - "all", - "virtualHostname" - ], - "x-supportedInSempDirect": true - }, - "post": { - "description": "Create a Virtual Hostname 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 Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\nvirtualHostname|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.17.", - "operationId": "createVirtualHostname", - "parameters": [ - { - "description": "The Virtual Hostname object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualHostname" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Virtual Hostname object's attributes after being created, and the request metadata.", - "schema": { - "$ref": "#/definitions/VirtualHostnameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Create a Virtual Hostname object.", - "tags": [ - "all", - "virtualHostname" - ], - "x-supportedInSempDirect": true - } - }, - "/virtualHostnames/{virtualHostname}": { - "delete": { - "description": "Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\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.17.", - "operationId": "deleteVirtualHostname", - "parameters": [ - { - "description": "The virtual hostname.", - "in": "path", - "name": "virtualHostname", - "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 Virtual Hostname object.", - "tags": [ - "all", - "virtualHostname" - ], - "x-supportedInSempDirect": true - }, - "get": { - "description": "Get a Virtual Hostname object.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying\n:---|:---:\nvirtualHostname|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.17.", - "operationId": "getVirtualHostname", - "parameters": [ - { - "description": "The virtual hostname.", - "in": "path", - "name": "virtualHostname", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Virtual Hostname object's attributes, and the request metadata.", - "schema": { - "$ref": "#/definitions/VirtualHostnameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Get a Virtual Hostname object.", - "tags": [ - "all", - "virtualHostname" - ], - "x-supportedInSempDirect": true - }, - "patch": { - "description": "Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\nvirtualHostname|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.17.", - "operationId": "updateVirtualHostname", - "parameters": [ - { - "description": "The virtual hostname.", - "in": "path", - "name": "virtualHostname", - "required": true, - "type": "string" - }, - { - "description": "The Virtual Hostname object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualHostname" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Virtual Hostname object's attributes after being updated, and the request metadata.", - "schema": { - "$ref": "#/definitions/VirtualHostnameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Update a Virtual Hostname object.", - "tags": [ - "all", - "virtualHostname" - ], - "x-supportedInSempDirect": true - }, - "put": { - "description": "Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\nvirtualHostname|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.17.", - "operationId": "replaceVirtualHostname", - "parameters": [ - { - "description": "The virtual hostname.", - "in": "path", - "name": "virtualHostname", - "required": true, - "type": "string" - }, - { - "description": "The Virtual Hostname object's attributes.", - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualHostname" - } - }, - { - "$ref": "#/parameters/opaquePasswordQuery" - }, - { - "$ref": "#/parameters/selectQuery" - }, - { - "$ref": "#/parameters/solSessionHeader" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "The Virtual Hostname object's attributes after being replaced, and the request metadata.", - "schema": { - "$ref": "#/definitions/VirtualHostnameResponse" - } - }, - "default": { - "description": "The error response.", - "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" - } - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "summary": "Replace a Virtual Hostname object.", - "tags": [ - "all", - "virtualHostname" - ], - "x-supportedInSempDirect": true - } - } - }, - "produces": [ - "application/json" - ], - "schemes": [ - "http", - "https" - ], - "securityDefinitions": { - "basicAuth": { - "description": "basic authentication", - "type": "basic" - } - }, - "swagger": "2.0", - "tags": [] -} \ No newline at end of file diff --git a/ci/template-test/providers.tf b/ci/template-test/providers.tf index d1de478..7d3de5d 100644 --- a/ci/template-test/providers.tf +++ b/ci/template-test/providers.tf @@ -3,7 +3,8 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebroker" + version = "~> 0.9" } } required_version = "~> 1.2" diff --git a/examples/adding-headers/README.md b/examples/adding-headers/README.md index 707e91f..d282b86 100644 --- a/examples/adding-headers/README.md +++ b/examples/adding-headers/README.md @@ -27,13 +27,13 @@ Important: The REST delivery point must have permission to consume messages from * `request_headers` - provided as a set of objects in the example. Also check the [using-substitution-expressions](/examples/using-substitution-expressions) example for additional samples. * `protected_request_headers` - provided as a set of objects in the example -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_rest_delivery_point_queue_binding"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_rest_delivery_point_queue_binding#optional). The module default for the `enabled` variable is true, which enables both the RDP and the REST consumer resources. ### Output -The module `rdp` output refers to the created REST delivery point. +The module `rdp`, `consumer` and `queue_binding` outputs refer to the created REST delivery point, REST consumer and queue binding. ## Created resources diff --git a/examples/adding-headers/providers.tf b/examples/adding-headers/providers.tf index 6dd1008..40543c5 100644 --- a/examples/adding-headers/providers.tf +++ b/examples/adding-headers/providers.tf @@ -17,7 +17,8 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebroker" + version = "~> 0.9" } } required_version = "~> 1.2" diff --git a/examples/basic/README.md b/examples/basic/README.md index 3cb3790..9e67e94 100644 --- a/examples/basic/README.md +++ b/examples/basic/README.md @@ -15,13 +15,13 @@ Important: The REST delivery point must have permission to consume messages from ### Optional Inputs -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_rest_delivery_point_rest_consumer"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_rest_delivery_point_rest_consumer#optional). The module default for the `enabled` variable is true, which enables both the RDP and the REST consumer resources. ### Output -The module `rdp` output refers to the created REST delivery point. +The module `rdp`, `consumer` and `queue_binding` outputs refer to the created REST delivery point, REST consumer and queue binding. ## Created resources diff --git a/examples/basic/providers.tf b/examples/basic/providers.tf index 6dd1008..40543c5 100644 --- a/examples/basic/providers.tf +++ b/examples/basic/providers.tf @@ -17,7 +17,8 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebroker" + version = "~> 0.9" } } required_version = "~> 1.2" diff --git a/examples/using-substitution-expressions/README.md b/examples/using-substitution-expressions/README.md index b0d6f5d..9cd88c7 100644 --- a/examples/using-substitution-expressions/README.md +++ b/examples/using-substitution-expressions/README.md @@ -16,7 +16,7 @@ Strings containing substitution expressions must be [properly escaped](https://d * `msg_vpn_name` - set to `default` in the example * `rest_delivery_point_name` -* `url` - set to `http://example.com/$${msgId()}` in the example. Notice the escape sequence, which results in `${msgId()` configured on the broker. Substitution expressions are only suported in the path component. +* `url` - set to `http://example.com/$${msgId()}` in the example. Notice the escape sequence, which results in `${msgId()}` configured on the broker. Substitution expressions are only suported in the path component. * `queue_name` - `rdp_queue`, the queue that has been created to be used with the RDP Important: The REST delivery point must have permission to consume messages from the queue — to achieve this, the queue’s owner must be set to `#rdp/` or the queue’s permissions for non-owner clients must be set to at least `consume` level access. Queue ingress and egress must also be enabled. @@ -27,13 +27,13 @@ Important: The REST delivery point must have permission to consume messages from Note that substitution expressions are not supported for `protected_request_headers`. -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_rest_delivery_point_rest_consumer"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_rest_delivery_point_rest_consumer#optional). The module default for the `enabled` variable is true, which enables both the RDP and the REST consumer resources. ### Output -The module `rdp` output refers to the created REST delivery point. +The module `rdp`, `consumer` and `queue_binding` outputs refer to the created REST delivery point, REST consumer and queue binding. ## Created resources @@ -44,6 +44,7 @@ This example will create following resources: * `solacebroker_msg_vpn_rest_delivery_point` * `solacebroker_msg_vpn_rest_delivery_point_rest_consumer` * `solacebroker_msg_vpn_rest_delivery_point_queue_binding` +* `solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_header` ## Running the Example diff --git a/examples/using-substitution-expressions/providers.tf b/examples/using-substitution-expressions/providers.tf index 6dd1008..40543c5 100644 --- a/examples/using-substitution-expressions/providers.tf +++ b/examples/using-substitution-expressions/providers.tf @@ -17,7 +17,8 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" + source = "registry.terraform.io/solaceproducts/solacebroker" + version = "~> 0.9" } } required_version = "~> 1.2" diff --git a/internal/gen-template/provider.tf b/internal/gen-template/provider.tf index 11e8b00..9ae85b6 100644 --- a/internal/gen-template/provider.tf +++ b/internal/gen-template/provider.tf @@ -3,8 +3,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" - # TODO: auto-update version + source = "registry.terraform.io/solaceproducts/solacebroker" version = "~> 0.9" } } diff --git a/provider.tf b/provider.tf index d0e66b6..256ae39 100644 --- a/provider.tf +++ b/provider.tf @@ -17,8 +17,7 @@ terraform { required_providers { solacebroker = { - source = "registry.terraform.io/solaceproducts/solacebroker" - # TODO: auto-update version + source = "registry.terraform.io/solaceproducts/solacebroker" version = "~> 0.9" } }