Criteria

PreviousRules NextDevices

Was this helpful?

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

Success

Body

securityPrincipalsobject

Security Principals Criteria

gatewaysobject

Gateways Criteria

oSsobject

OS Criteria Settings

iPsobject

IPs Criteria

hardwareIDsobject

Hardware IDs Criteria

accessenum

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesobject

Devices Criteria

themesobject

Themes Criteria

Request

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

Response

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

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

Criteria settings.

accessenum

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

securityPrincipalsEnablednullable boolean

Whether the Security Principals criteria is enabled or not

securityPrincipalsMatchingModeenum

Matching mode type options