Criteria

Get

Retrieve the criteria settings of a logon hours setting with the specified ID.

GET/api/LogonHours/{id}/Criteria

Path parameters

id*integer (int32)

The ID of a logon hours setting for which to retrieve the criteria settings.

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the logon hours rule

siteIdinteger (int32)

Site ID

descriptionnullable string

Description of the logon hours rule

enabledboolean

Whether the logon hours rule is enabled or not

orderinteger (int32)

Order of the logon hours rule

criteriaLogonHoursCriteria (object)

Logon Hours Criteria

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

Request

JavaScriptCurlPython

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

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:43:24.904Z",
  "timeLastMod": "2024-11-07T07:43:24.904Z",
  "name": "text",
  "description": "text",
  "enabled": false,
  "criteria": {
    "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"
        }
      ]
    },
    "devices": {
      "enabled": false,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "client": "text"
        }
      ]
    },
    "themes": {
      "enabled": false,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "ids": []
    }
  },
  "permittedHourPlan": {
    "sunday": [
      "1 = h00",
      "2 = h01",
      "4 = h02",
      "8 = h03",
      "16 = h04",
      "32 = h05",
      "64 = h06",
      "128 = h07",
      "256 = h08",
      "512 = h09",
      "1024 = h10",
      "2048 = h11",
      "4096 = h12",
      "8192 = h13",
      "16384 = h14",
      "32768 = h15",
      "65536 = h16",
      "131072 = h17",
      "262144 = h18",
      "524288 = h19",
      "1048576 = h20",
      "2097152 = h21",
      "4194304 = h22",
      "8388608 = h23"
    ],
    "monday": [
      "1 = h00",
      "2 = h01",
      "4 = h02",
      "8 = h03",
      "16 = h04",
      "32 = h05",
      "64 = h06",
      "128 = h07",
      "256 = h08",
      "512 = h09",
      "1024 = h10",
      "2048 = h11",
      "4096 = h12",
      "8192 = h13",
      "16384 = h14",
      "32768 = h15",
      "65536 = h16",
      "131072 = h17",
      "262144 = h18",
      "524288 = h19",
      "1048576 = h20",
      "2097152 = h21",
      "4194304 = h22",
      "8388608 = h23"
    ],
    "tuesday": [
      "1 = h00",
      "2 = h01",
      "4 = h02",
      "8 = h03",
      "16 = h04",
      "32 = h05",
      "64 = h06",
      "128 = h07",
      "256 = h08",
      "512 = h09",
      "1024 = h10",
      "2048 = h11",
      "4096 = h12",
      "8192 = h13",
      "16384 = h14",
      "32768 = h15",
      "65536 = h16",
      "131072 = h17",
      "262144 = h18",
      "524288 = h19",
      "1048576 = h20",
      "2097152 = h21",
      "4194304 = h22",
      "8388608 = h23"
    ],
    "wednesday": [
      "1 = h00",
      "2 = h01",
      "4 = h02",
      "8 = h03",
      "16 = h04",
      "32 = h05",
      "64 = h06",
      "128 = h07",
      "256 = h08",
      "512 = h09",
      "1024 = h10",
      "2048 = h11",
      "4096 = h12",
      "8192 = h13",
      "16384 = h14",
      "32768 = h15",
      "65536 = h16",
      "131072 = h17",
      "262144 = h18",
      "524288 = h19",
      "1048576 = h20",
      "2097152 = h21",
      "4194304 = h22",
      "8388608 = h23"
    ],
    "thursday": [
      "1 = h00",
      "2 = h01",
      "4 = h02",
      "8 = h03",
      "16 = h04",
      "32 = h05",
      "64 = h06",
      "128 = h07",
      "256 = h08",
      "512 = h09",
      "1024 = h10",
      "2048 = h11",
      "4096 = h12",
      "8192 = h13",
      "16384 = h14",
      "32768 = h15",
      "65536 = h16",
      "131072 = h17",
      "262144 = h18",
      "524288 = h19",
      "1048576 = h20",
      "2097152 = h21",
      "4194304 = h22",
      "8388608 = h23"
    ],
    "friday": [
      "1 = h00",
      "2 = h01",
      "4 = h02",
      "8 = h03",
      "16 = h04",
      "32 = h05",
      "64 = h06",
      "128 = h07",
      "256 = h08",
      "512 = h09",
      "1024 = h10",
      "2048 = h11",
      "4096 = h12",
      "8192 = h13",
      "16384 = h14",
      "32768 = h15",
      "65536 = h16",
      "131072 = h17",
      "262144 = h18",
      "524288 = h19",
      "1048576 = h20",
      "2097152 = h21",
      "4194304 = h22",
      "8388608 = h23"
    ],
    "saturday": [
      "1 = h00",
      "2 = h01",
      "4 = h02",
      "8 = h03",
      "16 = h04",
      "32 = h05",
      "64 = h06",
      "128 = h07",
      "256 = h08",
      "512 = h09",
      "1024 = h10",
      "2048 = h11",
      "4096 = h12",
      "8192 = h13",
      "16384 = h14",
      "32768 = h15",
      "65536 = h16",
      "131072 = h17",
      "262144 = h18",
      "524288 = h19",
      "1048576 = h20",
      "2097152 = h21",
      "4194304 = h22",
      "8388608 = h23"
    ]
  }
}

Update

Update the criteria settings of a logon hours setting with the specified ID.

PUT/api/LogonHours/{id}/Criteria

Path parameters

id*integer (int32)

The ID of a logon hours setting for which to modify the criteria settings.

Body

application/json; api-version=1.0

Criteria settings.

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/LogonHours/{id}/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"
}