Assignment

Get

Retrieve the assignment of a client policy.

GET/api/ClientPolicies/{id}/Assignment

Path parameters

id*integer (int32)

Client Policy ID

Response

Success

Body

rulesnullable array of ClientPolicyRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaClientPolicyCriteria (object)

Client Policy 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.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

Request

Response

Update

Update settings of a client policy assignment. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/ClientPolicies/{id}/Assignment

Path parameters

id*integer (int32)

Client policy ID

Body

Client policy assignment

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

Response

No Content

Request

Response

Update

Update settings of a client policy assignment. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/ClientPolicies/{id}/Assignment

Path parameters

id*integer (int32)

Client policy ID

Body

Client policy assignment

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

Response

No Content

Request

Response

Get

Retrieve the assignment of a client policy.

GET/api/ClientPolicies/{id}/Assignment

Path parameters

id*integer (int32)

Client Policy ID

Response

Success

Body

rulesnullable array of ClientPolicyRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaClientPolicyCriteria (object)

Client Policy 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.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

Request

Response

const response = await fetch('/api/ClientPolicies/{id}/Assignment', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('/api/ClientPolicies/{id}/Assignment', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "rules": [
    {
      "enabled": false,
      "name": "text",
      "description": "text",
      "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"
            }
          ]
        },
        "access": [
          "0 = DenyCriteriaWhen",
          "1 = AllowCriteriaWhen"
        ]
      }
    }
  ],
  "default": [
    "0 = Deny",
    "1 = Allow"
  ]
}