Rules

PreviousOrder NextCriteria

Was this helpful?

Remove

delete

Remove a rule from the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32required

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

ruleIdinteger · int32required

The ID of the Rule to remove.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/ClientPolicies/{id}/Rules/{ruleId}'

204

401

404

No Content

List

get

Retrieve the Rule List of a client policy with the specified ID.

Path parameters

idinteger · int32required

The ID of a client policy for which to retrieve the Rule settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/ClientPolicies/{id}/Rules'

200

401

404

[
  {
    "id": 1,
    "priority": 1,
    "enabled": true,
    "name": "text",
    "description": "text",
    "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"
          }
        ]
      },
      "access": [
        "0 = DenyCriteriaWhen",
        "1 = AllowCriteriaWhen"
      ],
      "devices": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "members": [
          {
            "client": "text"
          }
        ]
      },
      "themes": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "ids": [
          1
        ]
      }
    }
  }
]

Success

Get

get

Retrieve a rule from the Rule List of a client policy with the specified ID.

Path parameters

idinteger · int32required

The ID of a client policy for which to retrieve the Rule settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/ClientPolicies/{id}/Rules/{ruleId}'

200

401

404

{
  "id": 1,
  "priority": 1,
  "enabled": true,
  "name": "text",
  "description": "text",
  "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"
        }
      ]
    },
    "access": [
      "0 = DenyCriteriaWhen",
      "1 = AllowCriteriaWhen"
    ],
    "devices": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "client": "text"
        }
      ]
    },
    "themes": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "ids": [
        1
      ]
    }
  }
}

Success

Update

put

Update a rule within the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32required

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

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Body

Add a rule to the Rule list

enabledboolean | nullableoptional

Whether the rule will be enabled or disabled.

ruleNamestring | nullableoptional

The modified name of the rule.

descriptionstring | nullableoptional

The modified description of the rule.

prioritystring · enumoptional

Move Direction.

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/ClientPolicies/{id}/Rules/{ruleId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "ruleName": "text",
    "description": "text",
    "priority": [
      "0 = Up",
      "1 = Down"
    ]
  }'

204

401

404

No Content

Add

post

Add an Rule to the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32required

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

Body

Add a rule to the Rule list

enabledbooleanoptional

Whether the new rule will be enabled or disabled.

ruleNamestring | nullablerequired

The name of the rule to add to the Criteria.

descriptionstring | nullableoptional

Description for the new rule.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/ClientPolicies/{id}/Rules' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "ruleName": "text",
    "description": "text"
  }'

201

401

404

409

No Content

Created