Skip to main content

Configuring Client Forwarding Policies Using API

This article provides information on managing Zscaler Private Access (ZPA) client forwarding policy use cases using APIs. All APIs are rate limited. To learn more, see ZPA API Rate Limits.

Prerequisite API Call

To get the policySetId by policy type:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/policySet/policyType/{policyType}.

  2. Provide the policyType, the value for differentiating the policy types, in the request endpoint. The supported values are:

    • ACCESS_POLICY or GLOBAL_POLICY (i.e., access policy)
    • TIMEOUT_POLICY or REAUTH_POLICY (i.e., timeout policy)
    • BYPASS_POLICY or CLIENT_FORWARDING_POLICY (i.e., client forwarding policy)
    • INSPECTION_POLICY (i.e., AppProtection policy)
    • ISOLATION_POLICY (i.e., Isolation policy)
    • REDIRECTION_POLICY (i.e., redirection policy)
    • CAPABILITIES_POLICY (i.e., privileged capabilities policy)
    • CREDENTIAL_POLICY (i.e., privileged credential policy)
    • CLIENTLESS_SESSION_PROTECTION_POLICY (i.e., Browser Protection policy)
    • PRIVILEGED_PORTAL_POLICY (i.e., privileged portal policy)

    For example: /mgmtconfig/v1/admin/customers/217246660302995456/policySet/policyType/CLIENT_FORWARDING_POLICY.

Example Response​

{
  "id":"217246660303023168",
  "modifiedTime":"1624647543",
  "creationTime":"1562693881",
  "modifiedBy":"72057594037984006",
  "name":"Bypass_Policy",
  "enabled":true,
  "description":"Bypass policies.",
  "policyType":"4"
}

Pagination​

This API supports pagination. To get a paginated response:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/policySet/rules/policyType/{policyType}?page=1&pagesize=20.

  2. Provide the following in the request endpoint:

    • customerId: The ZPA tenant ID of the customer.
    • policyType: The value for differentiating the policy types. The supported values are:
      • ACCESS_POLICY or GLOBAL_POLICY (i.e., access policy)
      • TIMEOUT_POLICY or REAUTH_POLICY (i.e., timeout policy)
      • BYPASS_POLICY or CLIENT_FORWARDING_POLICY (i.e., client forwarding policy)
      • INSPECTION_POLICY (i.e., AppProtection policy)
      • ISOLATION_POLICY (i.e., Isolation policy)
      • REDIRECTION_POLICY (i.e., redirection policy)
      • CAPABILITIES_POLICY (i.e., privileged capabilities policy)
      • CREDENTIAL_POLICY (i.e., privileged credential policy)
      • CLIENTLESS_SESSION_PROTECTION_POLICY (i.e., Browser Protection policy)
      • PRIVILEGED_PORTAL_POLICY (i.e., privileged portal policy)
    • Valid values for page and page size parameters.

    For example: /mgmtconfig/v1/admin/customers/217246660302995456/policySet/rules/policyType/CLIENT_FORWARDING_POLICY?page=1&pagesize=2.

NOTE

If not provided, the default page size is 20. The maximum page size is 500.

A successful response returns code 200. To learn more, see ZPA API Codes.

Example Response​

{
  "totalPages":"3",
  "list":[
     {
        "id":"217246660303023826",
        "modifiedTime":"1628101611",
        "creationTime":"1590609953",
        "modifiedBy":"217246660303023906",
        "name":"allowall",
        "ruleOrder":"1",
        "priority":"5",
        "policyType":"4",
        "operator":"AND",
        "action":"INTERCEPT",
        "defaultRuleName":"Default_Rule",
        "defaultRule":false
     },
     {
        "id":"217246660303023636",
        "modifiedTime":"1628101611",
        "creationTime":"1577988747",
        "modifiedBy":"217246660303023906",
        "name":"user nodownload gets no apps",
        "ruleOrder":"2",
        "priority":"4",
        "policyType":"4",
        "operator":"AND",
        "conditions":[
           {
              "id":"288237",
              "modifiedTime":"1577988747",
              "creationTime":"1577988747",
              "modifiedBy":"217246660302995458",
              "operator":"OR",
              "negated":false,
              "operands":[
                 {
                    "id":"288238",
                    "creationTime":"1577988747",
                    "modifiedBy":"217246660302995458",
                    "objectType":"SAML",
                    "lhs":"217246660303022796",
                    "rhs":"nodownload",
                    "name":"username_Custom entityId IDP configuration - User sso - do NOT delete"
                 }
              ]
           }
        ],
        "action":"BYPASS",
        "defaultRuleName":"Default_Rule",
        "defaultRule":false
     }
  ]
}

Search Option​

This API supports a search option to get rules by action. To search by features and fields:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/policySet/rules/policyType/{policyType}?page=1&pagesize=20&search={searchString}.

  2. Provide the following in the request endpoint:

    • customerId: The ZPA tenant ID of the customer.
    • policyType: The value for differentiating the policy types. The supported values are:
      • ACCESS_POLICY or GLOBAL_POLICY (i.e., access policy)
      • TIMEOUT_POLICY or REAUTH_POLICY (i.e., timeout policy)
      • BYPASS_POLICY or CLIENT_FORWARDING_POLICY (i.e., client forwarding policy)
      • INSPECTION_POLICY (i.e., AppProtection policy)
      • ISOLATION_POLICY (i.e., Isolation policy)
      • REDIRECTION_POLICY (i.e., redirection policy)
      • CAPABILITIES_POLICY (i.e., privileged capabilities policy)
      • CREDENTIAL_POLICY (i.e., privileged credential policy)
      • CLIENTLESS_SESSION_PROTECTION_POLICY (i.e., Browser Protection policy)
      • PRIVILEGED_PORTAL_POLICY (i.e., privileged portal policy)
    • Valid page and page size values.
    • Valid search string values. The search string values are in the format action OPERATOR ruleAction. The supported ruleAction values for client forwarding policies are INTERCEPT (forward to ZPA), INTERCEPT_ACCESIBLE (only forward allowed applications), and BYPASS (bypass ZPA). The supported value for OPERATOR is EQ (i.e., equals). Only search string values that correspond to the values for valid rule actions and operators are supported. For example, the string action%20EQ%INTERCEPT is supported for the Rule Action filter, using the Equals operator, for the INTERCEPT rule action.

    For example: /mgmtconfig/v1/admin/customers/72057594037927936/policySet/rules/policyType/CLIENT_FORWARDING_POLICY?page=1&pagesize=500&search=action%20EQ%20INTERCEPT.

NOTE
  • If not provided, the default page size is 20. The maximum page size is 500.
  • If you use the ZPA API Portal or the API Reference to make your API calls, the search field string does not require any characters. For example, action%20EQ%20INTERCEPT is action EQ INTERCEPT.

A successful response returns code 200. To learn more, see ZPA API Codes.

Example Response​

{
   "totalPages":"4",
   "totalCount":"0",
   "list":[
      {
         "id":"72057594037992779",
         "creationTime":"1669125035",
         "modifiedBy":"72057594037928020",
         "name":"Posture11",
         "ruleOrder":"1",
         "priority":"2",
         "policyType":"4",
         "operator":"AND",
         "action":"INTERCEPT",
         "defaultRule":false,
         "defaultRuleName":"Default_Rule",
         "restrictedEntity":false
      },
      {
         "id":"72057594038018626",
         "creationTime":"1681997589",
         "modifiedBy":"72057594037941138",
         "name":"asd",
         "description":"ef",
         "ruleOrder":"2",
         "priority":"2",
         "policyType":"4",
         "operator":"AND",
         "action":"INTERCEPT",
         "defaultRule":false,
         "defaultRuleName":"Default_Rule",
         "restrictedEntity":false
      },
      {
         "id":"72057594038032911",
         "modifiedTime":"1687206863",
         "creationTime":"1687206863",
         "modifiedBy":"72057594037993401",
         "name":"Copy of asd",
         "description":"ef",
         "ruleOrder":"3",
         "priority":"2",
         "policyType":"4",
         "operator":"AND",
         "action":"INTERCEPT",
         "defaultRule":false,
         "defaultRuleName":"Default_Rule",
         "restrictedEntity":false
      }
   ]
}

Getting Required Details for the Client Forwarding Policy​

The following are the required details needed for the policy criteria:

Creating a New Client Forwarding Policy Rule

To add a new client forwarding rule for a given policy set and for a given customer:

  1. Send a POST request to the following endpoint: /mgmtconfig/v2/admin/customers/{customerId}/policySet/{policySetId}/rule.

  2. Provide the following values in the request endpoint:

    • customerId: The ZPA tenant ID of the customer.
    • policySetId: The ID of the global policy set captured in the prerequisite API call.

    For example: /mgmtconfig/v2/admin/customers/72057615512764416/policySet/72057615512764421/rule.

  3. Include the request headers to specify the following parameters about the request context:

    • Content-Type: application/json
    • Authorization: Bearer <access_token>

  4. Use the JSON payload and provide the policy criteria you want for creating a client forwarding rule with the specific SAML attributes as one of the criteria.

A successful response returns code 201. To learn more, see ZPA API Codes.

JSON Payload​

{
    "policySetId": "<policySetId>",
    "id": "<ruleId>",
    "conditions": [
        {
            "operands": [
                {
                    "objectType": "APP",
                    "values": [
                        "<applicationId>",
                        "<applicationId>",
                        "<applicationId>"
                    ]
                },
                {
                    "objectType": "APP_GROUP",
                    "values": [
                        "<segmentGroupId>"
                    ]
                }
            ]
        }
    ],
             "name":"<Example Policy Rule Name>",
    "description":"<Example Policy Rule Description>",
    "action":"INTERCEPT"
}

Minimum Criteria JSON Payload​

{
  "name":"PolicyName",
  "action":"RE_AUTH",
  "reauthTimeout":172800,
  "reauthIdleTimeout":600
}

Example Response​

{
  "id":"72057615512764645",
  "creationTime":"1612898408",
  "modifiedBy":"72057615512764644",
  "name":"Client Forwarding Policy Test",
  "description":"Description",
  "ruleOrder":"7",
  "priority":"1",
  "policyType":"1",
  "operator":"AND",
  "action":"ALLOW",
  "customMsg":"MsgString",
  "auditMessage":"{\"policyType\":\"Access Policy\",\"name\":\"Client Forwarding Policy Test\",\"description\":\"Description\",\"action\":\"ALLOW\",\"ruleOrder\":\"7\",\"messageToUser\":\"MsgString\"}"
}

Adding Field Descriptions

The following table includes descriptions of available fields you can use for the client forwarding policy use cases:

FieldDescriptionRequiredValue
nameThis is the name of the client forwarding ruleYesString
descriptionThis is the description of the client forwarding ruleNoString
actionThis is for providing the rule actionYesSupported values: INTERCEPT (forward to ZPA) (default value), INTERCEPT_ACCESIBLE (only forward allowed applications), BYPASS (bypass ZPA)
customMsgThis is for providing a custom message for the userNoString
conditionsThis is for providing the set of conditions for the policyNoArray of operands
operandsThis signifies the various policy criteriasNoArray of attributes (objectType, lhs, rhs, name)
objectTypeThis is for specifying the policy criteriaNoSupported values:
  • APP
  • APP_GROUP
  • SAML
  • IDP
  • CLIENT_TYPE
  • TRUSTED_NETWORK
  • POSTURE
  • SCIM
  • SCIM_GROUP
  • CLOUD_CONNECTOR_GROUP
TRUSTED_NETWORK is only supported for CLIENT_TYPE
lhsThis signifies the key for the object typeNoString ID example: id
rhsThis denotes the value for the given object type. Its value depends upon the key.NoFor APP, APP_GROUP, and IDP, the supported value is entity id
For CLIENT_TYPE, the supported values are: zpn_client_type_zapp for the Zscaler Client Connector and zpn_client_type_exporter (for Clientless).
For TRUSTED_NETWORK, the supported value is true.
operatorThis denotes the operation typeNoSupported values: AND, OR
microtenantIdThe unique identifier of the Microtenant for the ZPA tenant. If you are within a Microtenant, you must pass the microtenantId field when making an API call to retrieve data from that Microtenant. The microtenantId can be obtained in the API Keys page, or can be obtained programmatically using the ZPA cloud service API. Access to certain operations are limited when you are within a Microtenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. If the microtenantId is not passed in the request when creating or updating a resource, then the resource is created or updated in the Default Microtenant. To learn more, see Configuring Microtenants Using API.NoInteger

For a comprehensive table of LHS and RHS values, see Configuring Access Policies Using API.

Getting Details for a Particular Client Forwarding Rule

To get details for a particular client forwarding rule:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}.

  2. Provide the following values in the request endpoint:

    For example: /mgmtconfig/v1/admin/customers/72057615512764416/policySet/72057615512764421/rule/72057615512764645.

A successful response returns code 200. To learn more, see ZPA API Codes.

Example Response​

{
  "id":"72057615512764645",
  "creationTime":"1612898408",
  "modifiedBy":"72057615512764644",
  "name":"Client Forwarding Policy Test",
  "description":"Description",
  "ruleOrder":"7",
  "priority":"1",
  "policyType":"1",
  "operator":"AND",
  "action":"ALLOW",
  "customMsg":"MsgString",
  "auditMessage":"{\"policyType\":\"Access Policy\",\"name\":\"Client Forwarding Policy Test\",\"description\":\"Description\",\"action\":\"ALLOW\",\"ruleOrder\":\"7\",\"messageToUser\":\"MsgString\"}",
  "policySetId":"72057615512764421"
}

Updating a Client Forwarding Policy Rule

To update the details of a client forwarding rule in the policy set:

  1. Get the policySetId provided in prerequisite API call.

  2. Use the updated JSON payload from Creating a New Client Forwarding Policy Rule and send a PUT request to the following endpoint: /mgmtconfig/v2/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}.

  3. Provide the following values in the request endpoint:

    For example: /mgmtconfig/v2/admin/customers/72057615512764416/policySet/72057615512764421/rule/72057615512764645.

A successful response returns code 204, meaning the client forwarding rule is updated. To learn more, see ZPA API Codes.

JSON Payload​

{
    "policySetId": "<policySetId>",
    "id": "<ruleId>",
    "conditions": [
        {
            "operands": [
                {
                    "objectType": "APP",
                    "values": [
                        "<applicationId>",
                        "<applicationId>",
                        "<applicationId>"
                    ]
                },
                {
                    "objectType": "APP_GROUP",
                    "values": [
                        "<segmentGroupId>"
                    ]
                }
            ]
        }
    ],
             "name":"<Example Policy Rule Name>",
    "description":"<Example Policy Rule Description>",
    "action":"INTERCEPT"
}

Updating a Rule Order

To update a rule order:

  1. Send a PUT request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}/reorder/{newOrder}.

  2. Provide the following parameters in the request endpoint:

    • customerId: The ZPA tenant ID of the customer.
    • policySetId: The ID of the policy set.
    • ruleId: The ID of the rule.
    • newOrder: The new order of the rule.

    For example: mgmtconfig/v1/admin/customers/72057594037927936/policySet/72057594037938994/rule/72057615512764641/reorder/4.

A successful response returns code 204, meaning the rule order is updated. To learn more, see ZPA API Codes.

NOTE

The ability to update the rule order for all rules in a policy set is also available. To learn more, see Configuring Access Policies Using API.

Deleting a Client Forwarding Rule

To delete a client forwarding rule:

  1. Send a DELETE request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/policySet/{policySetId}/rule/{ruleId}.

  2. Provide the following values in the request endpoint:

    For example: /mgmtconfig/v1/admin/customers/72057615512764416/policySet/72057615512764421/rule/72057615512764645.

A successful response yields code 204, meaning the client forwarding rule is deleted. To learn more, see ZPA API Codes.

Getting Details of All Client Types

To get details of all client types:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/clientTypes.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/217246660302995456/clientTypes.

A successful response returns code 200. To learn more, see ZPA API Codes.

Example Response​

{
"zpn_client_type_exporter": "Web Browser",
"zpn_client_type_exporter_noauth": "Web Browser Unauthenticated",
"zpn_client_type_machine_tunnel": "Machine Tunnel",
"zpn_client_type_edge_connector": "Cloud Connector",
"zpn_client_type_zia_inspection": "ZIA Inspection",
"zpn_client_type_zapp": "Client Connector",
"zpn_client_type_slogger": "ZPA LSS",
"zpn_client_type_browser_isolation": "Cloud Browser",
"zpn_client_type_ip_anchoring": "ZIA Service Edge",
"zpn_client_type_zapp_partner": "Client Connector Partner",
"zpn_client_type_branch_connector": "Branch Connector",
"zpn_client_type_vdi":"Client Connector for VDI"
}

Getting Platform Types for a Customer

To get the platform types for a customer:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/platform.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/217246660302995456/platform.

A successful response returns code 200. To learn more, see ZPA API Codes.

Example Response​

{
  "linux":"Linux",
  "android":"Android",
  "windows":"Windows",
  "ios":"iOS",
  "mac":"Mac"
}