1 of 8

Criteria

Devices

Gateway IPs

Hardware IDs

IPs

OSes

Security Principals

Themes

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

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

Request

Response

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

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

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

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

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

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

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

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "ip": "text",
      "ipType": [
        "0 = Version4",
        "1 = Version6",
        "2 = BothVersions"
      ]
    }),
});
const data = await response.json();

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

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

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

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/IPs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "ip": "text",
      "ipType": [
        "0 = Version4",
        "1 = Version6",
        "2 = BothVersions"
      ]
    }),
});
const data = await response.json();

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

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();

{
  "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": []
  }
}

Criteria

Devices

Gateway IPs

Hardware IDs

IPs

OSes

Security Principals

Themes

OSes

Get

Update

Devices

List

Add

Remove

Gateway IPs

List

Add

Remove

Security Principals

List

Add

Remove

IPs

List

Add

Remove

Themes

List

Add

Remove

Hardware IDs

List

Add

Remove

Criteria

Get

Update

List

Remove

Remove

Remove

Remove

Remove

List

List

List

Add

Add

Remove

List

Add

Add

Add

Get

Add

Update

List

Update

Get