Logon Hours

List

Retrieve information about one or multiple logon hours setting.

GET/api/LogonHours

Query parameters

SiteIdinteger (int32)

Site ID from which to retrieve the logon hours setting (optional).

Namestring

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.

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

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

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

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

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

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

Hour Plan

Request

Response

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

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

No Content

Request

Response

Security Principals

List

Retrieve Criteria Security Principal List of a session server with the specified ID.

GET/api/LogonHours/{id}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

The ID of a session server for which to retrieve the Criteria settings.

Response

Success

Body

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.

Request

Response

Add

Add a user, group or machine to the Security Principal List of the Criteria settings.

POST/api/LogonHours/{id}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Criteria settings.

Body

SecurityPrincipal configuration.

accountnullable string

The name of the account to add to the Criteria.

sidnullable string

The SID of the account to add to the Criteria.

Response

Created

Request

Response

Remove

Remove a user, group or machine from the Security Principal List of the Criteria settings.

DELETE/api/LogonHours/{id}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Criteria settings.

Body

SecurityPrincipal configuration.

accountnullable string

The name of the account to remove from the Criteria.

sidnullable string

The SID of the account to remove from the Criteria.

Response

No Content

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

Hour Plan

Request

Response

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

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

No Content

Request

Response

List

Retrieve information about one or multiple logon hours setting.

GET/api/LogonHours

Query parameters

SiteIdinteger (int32)

Site ID from which to retrieve the logon hours setting (optional).

Namestring

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.

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

Hour Plan

Request

Response

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

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

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.

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)

permittedHourPlanPermittedHourPlan (object)

Permitted Hour Plan

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

Hour Plan

Request

Response

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:08:48.623Z",
  "timeLastMod": "2024-11-07T10:08:48.623Z",
  "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"
    ]
  }
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:08:48.623Z",
  "timeLastMod": "2024-11-07T10:08:48.623Z",
  "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"
    ]
  }
}

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:08:48.623Z",
    "timeLastMod": "2024-11-07T10:08:48.623Z",
    "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"
      ]
    }
  }
]

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:08:48.623Z",
  "timeLastMod": "2024-11-07T10:08:48.623Z",
  "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"
    ]
  }
}

OSes

Get

Retrieve Criteria OS of a session server with the specified ID.

GET/api/LogonHours/{id}/Criteria/OSes

Path parameters

id*integer (int32)

The ID of a session server for which to retrieve the Criteria settings.

Response

Success

Body

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.

Request

Response

Update

Modify the OS of the Criteria settings.

PUT/api/LogonHours/{id}/Criteria/OSes

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Criteria settings.

Body

OS configuration.

allowClientChromenullable boolean

Allow Chrome OS clients.

allowClientAndroidnullable boolean

Allow Android clients.

allowClientWebnullable boolean

Allow Web clients.

allowClientIOSnullable boolean

Allow IOS clients.

allowClientLinuxnullable boolean

Allow Linux clients.

allowClientMACnullable boolean

Allow Mac clients.

allowClientWindowsnullable boolean

Allow Windows clients.

allowClientWysenullable boolean

Allow Wyse clients.

Response

No Content

Request

Response

IPs

List

Retrieve Criteria IP List of a session server with the specified ID.

GET/api/LogonHours/{id}/Criteria/IPs

Path parameters

id*integer (int32)

The ID of a session server for which to retrieve the Criteria settings.

Response

Success

Body

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

Request

Response

Add

Add an IP to the IP List of the Criteria settings.

POST/api/LogonHours/{id}/Criteria/IPs

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Criteria settings.

Body

IP configuration.

ip*nullable string

Value that represents the IP

ipType*IPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

Response

Created

Request

Response

Remove

Remove an IP from the IP List of the Criteria settings.

DELETE/api/LogonHours/{id}/Criteria/IPs

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Criteria settings.

Body

IP configuration.

ip*nullable string

Value that represents the IP

ipType*IPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

Response

No Content

Request

Response

Day Plan

Get

Retrieve information about day plan properties from the logon hours setting.

GET/api/LogonHours/{id}/DayPlan

Path parameters

id*integer (int32)

The ID for which to retrieve the Day Plan settings.

Response

Success

Body

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

Hour Plan

Request

Response

Update

Modify properties of day plan properties from the logon hours setting.

PUT/api/LogonHours/{id}/DayPlan

Path parameters

id*integer (int32)

The ID for which to modify the Day Plan.

Body

Day Plan Settings.

objType*DayPlanObjType (enum)

RAS Day Plan Object Types

98 = LogonHours

permissionPermission (enum)

Permit Or Deny

0 = Deny,1 = Permit

weekDays*WeekDays (enum)

Week Days

0 = None,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

hourPlan*HourPlan (enum)

Hour Plan

Response

No Content

Request

Response

Get

Retrieve information about day plan properties from the logon hours setting.

GET/api/LogonHours/{id}/DayPlan

Path parameters

id*integer (int32)

The ID for which to retrieve the Day Plan settings.

Response

Success

Body

sundayHourPlan (enum)

Hour Plan

mondayHourPlan (enum)

Hour Plan

tuesdayHourPlan (enum)

Hour Plan

wednesdayHourPlan (enum)

Hour Plan

thursdayHourPlan (enum)

Hour Plan

fridayHourPlan (enum)

Hour Plan

saturdayHourPlan (enum)

Hour Plan

Request

Response

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

Logon Hours

Criteria

Devices

Gateway IPs

Hardware IDs

IPs

OSes

Security Principals

Themes

Day Plan

Order

Logon Hours

List

Create

Get

Update

Delete

Devices

Criteria

List

Add

Remove

Get

Update

Security Principals

List

Add

Remove

Gateway IPs

List

Add

Remove

Delete

List

List

Remove

Remove

Remove

Update

Add

List

Add

Add

Get

Create

Update

List

Get

Hardware IDs

List

Add

Remove

Order

Update Order

Themes

List

Add

Remove

OSes

Get

Update

IPs

List

Add

Remove

Day Plan

Get

Update

List

Remove

Remove

Update Order

List

Add

Remove

Add

Get

Add

Update

List