Criteria

Get

Retrieve the Criteria settings of a published item with the specified ID.

GET/api/PubItems/{id}/Rules/{ruleId}/Criteria

Path parameters

id*integer (int32)

The ID of a published item for which to retrieve the Criteria settings.

ruleId*integer (int32)

The ID of the Rule to retrieve.

Response

200401404

Success

Body

application/json; api-version=1.0

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

gatewaysGatewaysCriteria (object)

Gateways Criteria

oSsOSsCriteria (object)

OS Criteria Settings

iPsIPsCriteria (object)

IPs Criteria

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

themesThemesCriteria (object)

Themes Criteria

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "securityPrincipals": {
    "enabled": false,
    "matchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "members": [
      {
        "account": "text",
        "type": [
          "1 = User",
          "2 = Group",
          "3 = ForeignSecurityPrincipal",
          "4 = Computer"
        ],
        "sid": "text"
      }
    ]
  },
  "gateways": {
    "enabled": false,
    "matchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "members": [
      {
        "gatewayIP": "text"
      }
    ]
  },
  "oSs": {
    "enabled": false,
    "matchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "allowedOSes": {
      "chrome": false,
      "android": false,
      "webClient": false,
      "iOS": false,
      "linux": false,
      "mac": false,
      "wyse": false,
      "windows": false
    }
  },
  "iPs": {
    "enabled": false,
    "matchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "allowedIPs": {
      "iPv4s": [
        {
          "from": "text",
          "to": "text"
        }
      ],
      "iPv6s": [
        {
          "from": "text",
          "to": "text"
        }
      ]
    }
  },
  "hardwareIDs": {
    "enabled": false,
    "matchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "members": [
      {
        "hardwareID": "text"
      }
    ]
  },
  "access": [
    "0 = DenyCriteriaWhen",
    "1 = AllowCriteriaWhen"
  ],
  "devices": {
    "enabled": false,
    "matchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "members": [
      {
        "client": "text"
      }
    ]
  },
  "themes": {
    "enabled": false,
    "matchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "ids": []
  }
}

Update

Update the Criteria settings of a published item with the specified ID.

PUT/api/PubItems/{id}/Rules/{ruleId}/Criteria

Path parameters

id*integer (int32)

The ID of a published item for which to modify the Criteria settings.

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

application/json; api-version=1.0

Criteria settings.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

securityPrincipalsEnablednullable boolean

Whether the Security Principals criteria is enabled or not

securityPrincipalsMatchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

gatewaysEnablednullable boolean

Whether the Gateways criteria is enabled or not

gatewaysMatchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

themesEnablednullable boolean

Whether the Themes criteria is enabled or not

themesMatchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

devicesEnablednullable boolean

Whether the Devices criteria is enabled or not

devicesMatchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

oSsEnablednullable boolean

Whether the OSs criteria is enabled or not

oSsMatchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

iPsEnablednullable boolean

Whether the IPs criteria is enabled or not

iPsMatchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

hardwareIDsEnablednullable boolean

Whether the HardwareIDs criteria is enabled or not

hardwareIDsMatchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}