Ctrlk
ProductsSupportPartnersDocumentation
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Criteria

Get

get

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

Path parameters
idinteger · int32Required

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

Responses
200

Success

application/json; api-version=1.0

Logon Hours

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

namestring · nullableOptional

Name of the logon hours rule

siteIdinteger · int32Optional

Site ID

descriptionstring · nullableOptional

Description of the logon hours rule

enabledbooleanOptional

Whether the logon hours rule is enabled or not

orderinteger · int32Optional

Order of the logon hours rule

get/api/LogonHours/{id}/Criteria
GET /api/LogonHours/{id}/Criteria HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-01-01T00:00:00.000Z",
  "timeLastMod": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "siteId": 1,
  "description": "text",
  "enabled": true,
  "order": 1,
  "criteria": {
    "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"
        }
      ]
    },
    "devices": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "client": "text"
        }
      ]
    },
    "themes": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "ids": [
        1
      ]
    }
  },
  "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

put

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

Path parameters
idinteger · int32Required

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

Body
securityPrincipalsEnabledboolean · nullableOptional

Whether the Security Principals criteria is enabled or not

securityPrincipalsMatchingModestring · enumOptional

Matching mode type options

Possible values:
gatewaysEnabledboolean · nullableOptional

Whether the Gateways criteria is enabled or not

gatewaysMatchingModestring · enumOptional

Matching mode type options

Possible values:
themesEnabledboolean · nullableOptional

Whether the Themes criteria is enabled or not

themesMatchingModestring · enumOptional

Matching mode type options

Possible values:
devicesEnabledboolean · nullableOptional

Whether the Devices criteria is enabled or not

devicesMatchingModestring · enumOptional

Matching mode type options

Possible values:
oSsEnabledboolean · nullableOptional

Whether the OSs criteria is enabled or not

oSsMatchingModestring · enumOptional

Matching mode type options

Possible values:
iPsEnabledboolean · nullableOptional

Whether the IPs criteria is enabled or not

iPsMatchingModestring · enumOptional

Matching mode type options

Possible values:
hardwareIDsEnabledboolean · nullableOptional

Whether the HardwareIDs criteria is enabled or not

hardwareIDsMatchingModestring · enumOptional

Matching mode type options

Possible values:
Responses
204

No Content

No content
put/api/LogonHours/{id}/Criteria
PUT /api/LogonHours/{id}/Criteria HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 722

{
  "securityPrincipalsEnabled": true,
  "securityPrincipalsMatchingMode": [
    "0 = IsNotOneOfTheFollowing",
    "1 = IsOneOfTheFollowing"
  ],
  "gatewaysEnabled": true,
  "gatewaysMatchingMode": [
    "0 = IsNotOneOfTheFollowing",
    "1 = IsOneOfTheFollowing"
  ],
  "themesEnabled": true,
  "themesMatchingMode": [
    "0 = IsNotOneOfTheFollowing",
    "1 = IsOneOfTheFollowing"
  ],
  "devicesEnabled": true,
  "devicesMatchingMode": [
    "0 = IsNotOneOfTheFollowing",
    "1 = IsOneOfTheFollowing"
  ],
  "oSsEnabled": true,
  "oSsMatchingMode": [
    "0 = IsNotOneOfTheFollowing",
    "1 = IsOneOfTheFollowing"
  ],
  "iPsEnabled": true,
  "iPsMatchingMode": [
    "0 = IsNotOneOfTheFollowing",
    "1 = IsOneOfTheFollowing"
  ],
  "hardwareIDsEnabled": true,
  "hardwareIDsMatchingMode": [
    "0 = IsNotOneOfTheFollowing",
    "1 = IsOneOfTheFollowing"
  ]
}
No content
PreviousLogon Hours
NextDevices