Logon Hours

List

Retrieve information about one or multiple logon hours setting.

GET/api/LogonHours

Query parameters

Response

Success

Body

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

Response

Create

Create a new logon hours setting.

POST/api/LogonHours

Body

Logon hours settings

name*nullable string

The name of the target logon hours rule. This must be the actual logon hours rule name used in the RAS Farm.

enabledboolean

Enable or disable the logon hours rule upon creation. If the parameter is omitted, the logon hours rule is initialised as disabled.

descriptionnullable string

A user-defined logon hours rule description.

Response

Created

Body

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

Response

Get

Retrieve information about a particular logon hours setting by ID.

GET/api/LogonHours/{id}

Path parameters

id*integer (int32)

The ID of the logon hours setting for which to retrieve the information.

Response

Success

Body

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

Response

Update

Modify properties of a logon hours setting.

PUT/api/LogonHours/{id}

Path parameters

id*integer (int32)

The ID of the logon hours setting to modify.

Body

Logon hours settings

enablednullable boolean

Enable or disable the specified logon hours rule in a Site.

namenullable string

The new name of the target logon hours rule.

descriptionnullable string

A user-defined LogonHours description.

Response

No Content

Request

Response

Delete

Remove a logon hours setting from a Site.

DELETE/api/LogonHours/{id}

Path parameters

id*integer (int32)

The ID of a logon hours setting to remove from the Site.

Response

No Content

Request

Response

PreviousLoad Balancing NextCriteria

Last updated 9 months ago

{ "id": 0, "adminCreate": "text", "adminLastMod": "text", "timeCreate": "2024-12-21T14:30:13.292Z", "timeLastMod": "2024-12-21T14:30:13.292Z", "name": "text", "siteId": 0, "description": "text", "enabled": false, "order": 0, "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": [ 0 ] } }, "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" ] } }

[ { "id": 0, "adminCreate": "text", "adminLastMod": "text", "timeCreate": "2024-12-21T14:30:13.292Z", "timeLastMod": "2024-12-21T14:30:13.292Z", "name": "text", "siteId": 0, "description": "text", "enabled": false, "order": 0, "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": [ 0 ] } }, "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" ] } } ]