Logon Hours
Was this helpful?
Was this helpful?
Retrieve information about a particular logon hours setting by ID.
The ID of the logon hours setting for which to retrieve the information.
curl -L \
--url '/api/LogonHours/{id}'{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-04-06T01:55:54.371Z",
"timeLastMod": "2025-04-06T01:55:54.371Z",
"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"
]
}
}Success
Remove a logon hours setting from a Site.
The ID of a logon hours setting to remove from the Site.
curl -L \
--request DELETE \
--url '/api/LogonHours/{id}'No Content
No Content
Retrieve information about one or multiple logon hours setting.
Site ID from which to retrieve the logon hours setting (optional).
The name of the logon hours setting for which to retrieve the information. This must be the actual logon hours setting name used in the RAS connections.
curl -L \
--url '/api/LogonHours'[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-04-06T01:55:54.371Z",
"timeLastMod": "2025-04-06T01:55:54.371Z",
"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"
]
}
}
]Success
Create a new logon hours setting.
Create a new logon hours property
The name of the target logon hours rule. This must be the actual logon hours rule name used in the RAS Farm.
Enable or disable the logon hours rule upon creation. If the parameter is omitted, the logon hours rule is initialised as disabled.
A user-defined logon hours rule description.
curl -L \
--request POST \
--url '/api/LogonHours' \
--header 'Content-Type: application/json; api-version=1.0' \
--data '{
"name": "text",
"enabled": true,
"description": "text"
}'{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-04-06T01:55:54.371Z",
"timeLastMod": "2025-04-06T01:55:54.371Z",
"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"
]
}
}Created
Modify properties of a logon hours setting.
The ID of the logon hours setting to modify.
Update a logon hours property settings
Enable or disable the specified logon hours rule in a Site.
The new name of the target logon hours rule.
A user-defined LogonHours description.
curl -L \
--request PUT \
--url '/api/LogonHours/{id}' \
--header 'Content-Type: application/json; api-version=1.0' \
--data '{
"enabled": true,
"name": "text",
"description": "text"
}'No Content
No Content