You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/zia_ssl_inspection_rules.md
+80-64Lines changed: 80 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -180,134 +180,150 @@ The following arguments are supported:
180
180
181
181
### Required
182
182
183
-
*`name` - (String) Name of the SSL Inspection
184
-
*`order` - (String) Unique identifier for the SSL Inspection
183
+
-`name` - (String) Name of the SSL Inspection
184
+
-`order` - (String) Unique identifier for the SSL Inspection
185
185
186
186
## Attribute Reference
187
187
188
188
In addition to all arguments above, the following attributes are supported:
189
189
190
-
*`description` (String) - Enter additional notes or information. The description cannot exceed 10,240 characters.
191
-
*`order` (String) - Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
192
-
*`state` (String) - The state of the rule indicating whether it is enabled or disabled. Supported values: `ENABLED` or `DISABLED`
193
-
*`rank` (Integer) - The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
194
-
*`access_control` (String) - The access privilege (RBA) for this rule.
195
-
*`road_warrior_for_kerberos` (Boolean) - Indicates whether this rule is applied to remote users that use PAC with Kerberos authentication.
196
-
*`platforms` (Set of String) - Zscaler Client Connector device platforms for which this rule is applied. Supported Values: `SCAN_IOS`, `SCAN_ANDROID`, `SCAN_MACOS`, `SCAN_WINDOWS`, `NO_CLIENT_CONNECTOR`, `SCAN_LINUX`
197
-
*`cloud_applications` (Set of String) - The list of URL categories to which the DLP policy rule must be applied. For the complete list of supported file types refer to the [ZIA API documentation](https://help.zscaler.com/zia/data-loss-prevention#/webDlpRules-post)
198
-
*`url_categories` (Set of String) - The list of URL categories to which the DLP policy rule must be applied.
199
-
*`user_agent_types` (Set of String) - A list of user agent types the rule applies to.
200
-
*`device_trust_levels` (Set of String) - List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation. Supported values: `ANY`, `UNKNOWN_DEVICETRUSTLEVEL`, `LOW_TRUST`, `MEDIUM_TRUST`, `HIGH_TRUST`
201
-
*`action` (Block List) - Action taken when the traffic matches policy
202
-
*`devices` (Block List) - ID pairs of devices for which the rule is applied
203
-
*`device_groups` (Block List) - ID pairs of device groups for which the rule is applied.
204
-
*`departments` (Block List) - ID pairs of departments for which the rule is applied.
205
-
*`groups` (Block List) - ID pairs of groups for which the rule is applied. If not set, rule is applied for all groups.
206
-
*`labels` (Block List) - ID pairs of labels associated with the rule.
207
-
*`locations` (Block List) - ID pairs of locations to which the rule is applied. When empty, it implies applying to all locations.
208
-
*`location_groups` (Block List) - ID pairs of location groups to which the rule is applied. When empty, it implies applying to all location groups.
209
-
*`dest_ip_groups` (Block List) - ID pairs of destination IP address groups for which the rule is applied.
210
-
*`source_ip_groups` (Block List) - ID pairs of source IP address groups for which the rule is applied.
211
-
*`proxy_gateways` (Block List) - When using ZPA Gateway forwarding, name-ID pairs of ZPA Application Segments for which the rule is applicable.
212
-
*`zpa_app_segments` (Block List) - The list of ZPA Application Segments for which this rule is applicable (applicable only for ZPA Gateway forwarding).
213
-
*`workload_groups` (Block List) - The list of preconfigured workload groups to which the policy must be applied.
214
-
*`time_windows` (Block List) - The time intervals during which the rule applies
215
-
*`users` (Block List) - The list of preconfigured workload groups to which the policy must be applied.
190
+
-`description` (String) - Enter additional notes or information. The description cannot exceed 10,240 characters.
191
+
-`order` (String) - Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
192
+
-`state` (String) - The state of the rule indicating whether it is enabled or disabled. Supported values: `ENABLED` or `DISABLED`
193
+
-`rank` (Integer) - The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
194
+
-`access_control` (String) - The access privilege (RBA) for this rule.
195
+
-`road_warrior_for_kerberos` (Boolean) - Indicates whether this rule is applied to remote users that use PAC with Kerberos authentication.
196
+
-`platforms` (Set of String) - Zscaler Client Connector device platforms for which this rule is applied. Supported Values: `SCAN_IOS`, `SCAN_ANDROID`, `SCAN_MACOS`, `SCAN_WINDOWS`, `NO_CLIENT_CONNECTOR`, `SCAN_LINUX`
197
+
-`cloud_applications` (Set of String) - The list of URL categories to which the DLP policy rule must be applied. For the complete list of supported file types refer to the [ZIA API documentation](https://help.zscaler.com/zia/data-loss-prevention#/webDlpRules-post)
198
+
-`url_categories` (Set of String) - The list of URL categories to which the DLP policy rule must be applied.
199
+
-`user_agent_types` (Set of String) - A list of user agent types the rule applies to.
200
+
-`device_trust_levels` (Set of String) - List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation. Supported values: `ANY`, `UNKNOWN_DEVICETRUSTLEVEL`, `LOW_TRUST`, `MEDIUM_TRUST`, `HIGH_TRUST`
201
+
-`action` (Block List) - Action taken when the traffic matches policy
202
+
-`devices` (Block List) - ID pairs of devices for which the rule is applied
203
+
-`device_groups` (Block List) - ID pairs of device groups for which the rule is applied.
204
+
-`departments` (Block List) - ID pairs of departments for which the rule is applied.
205
+
-`groups` (Block List) - ID pairs of groups for which the rule is applied. If not set, rule is applied for all groups.
206
+
-`labels` (Block List) - ID pairs of labels associated with the rule.
207
+
-`locations` (Block List) - ID pairs of locations to which the rule is applied. When empty, it implies applying to all locations.
208
+
-`location_groups` (Block List) - ID pairs of location groups to which the rule is applied. When empty, it implies applying to all location groups.
209
+
-`dest_ip_groups` (Block List) - ID pairs of destination IP address groups for which the rule is applied.
210
+
-`source_ip_groups` (Block List) - ID pairs of source IP address groups for which the rule is applied.
211
+
-`proxy_gateways` (Block List) - When using ZPA Gateway forwarding, name-ID pairs of ZPA Application Segments for which the rule is applicable.
212
+
-`zpa_app_segments` (Block List) - The list of ZPA Application Segments for which this rule is applicable (applicable only for ZPA Gateway forwarding).
213
+
-`workload_groups` (Block List) - The list of preconfigured workload groups to which the policy must be applied.
214
+
-`time_windows` (Block List) - The time intervals during which the rule applies
215
+
-`users` (Block List) - The list of preconfigured workload groups to which the policy must be applied.
216
216
217
217
### Action Attributes
218
218
219
219
`action` has the following attributes:
220
220
221
-
*`type` (String) - The action type for this rule. Possible values: `BLOCK`, `DECRYPT`, or `DO_NOT_DECRYPT`.
222
-
*`show_eun` (Boolean) - Whether to show End User Notification (EUN).
223
-
*`show_eunatp` (Boolean) - Whether to display the EUN ATP page.
224
-
*`override_default_certificate` (Boolean) - Whether to override the default SSL interception certificate.
225
-
*`ssl_interception_cert` (Block List) - The SSL interception certificate to be used. If not set it will use the default Zscaler certificate
226
-
*`decrypt_sub_actions` (Block List) - Action taken when enabling SSL intercept
227
-
*`do_not_decrypt_sub_actions` (Block List) - Action taken when bypassing SSL intercept
221
+
-`type` (String) - The action type for this rule. Possible values: `BLOCK`, `DECRYPT`, or `DO_NOT_DECRYPT`.
222
+
-`show_eun` (Boolean) - Whether to show End User Notification (EUN).
223
+
-`show_eunatp` (Boolean) - Whether to display the EUN ATP page.
224
+
-`override_default_certificate` (Boolean) - Whether to override the default SSL interception certificate.
225
+
-`ssl_interception_cert` (Block List) - The SSL interception certificate to be used. If not set it will use the default Zscaler certificate
226
+
-`decrypt_sub_actions` (Block List) - Action taken when enabling SSL intercept
227
+
-`do_not_decrypt_sub_actions` (Block List) - Action taken when bypassing SSL intercept
228
228
229
229
### ssl_interception_cert Attributes
230
230
231
231
`ssl_interception_cert` has the following attributes:
232
+
**NOTE** This block can only be set when `override_default_certificate` is `true`
232
233
233
-
*`id` (Integer) - The unique ID of the SSL interception certificate.
234
-
*`name` (String) - The name of the SSL interception certificate.
235
-
*`default_certificate` (Boolean) - Indicates if this certificate is the default certificate.
234
+
-`id` (Integer) - The unique ID of the SSL interception certificate.
235
+
236
+
### action.type `BLOCK`
237
+
238
+
`action` has the following attributes:
239
+
240
+
-`type` (String) - The action type for this rule. Possible values: `BLOCK`.
241
+
-`show_eun` (Boolean) - Enable this setting to display end user notifications.
242
+
-`override_default_certificate` (Boolean) - Whether to override the default SSL interception certificate.
243
+
-`ssl_interception_cert` has the following attributes:
244
+
**NOTE** This block can only be set when `override_default_certificate` is `true`
245
+
246
+
-`id` (Integer) - The unique ID of the SSL interception certificate.
236
247
237
248
### decrypt_sub_actions Attributes
238
249
239
250
`decrypt_sub_actions` has the following attributes:
240
251
241
-
*`server_certificates` (String) - Action to take on server certificates. Valid values might include `ALLOW`, `BLOCK`, or `PASS_THRU`.
242
-
*`ocsp_check` (Boolean) - Whether to enable OCSP check.
243
-
*`block_ssl_traffic_with_no_sni_enabled` (Boolean) - Whether to block SSL traffic when SNI is not present.
244
-
*`min_client_tls_version` (String) - The minimum TLS version allowed on the client side: Supported Values are: `CLIENT_TLS_1_0`, `CLIENT_TLS_1_1`, `CLIENT_TLS_1_2`, `CLIENT_TLS_1_3`.
245
-
*`min_server_tls_version` (String) - The minimum TLS version allowed on the server side: Supported Values are: `SERVER_TLS_1_0`, `SERVER_TLS_1_1`, `SERVER_TLS_1_2`, `SERVER_TLS_1_3`.
246
-
*`block_undecrypt` (Boolean) - Enable to block traffic from servers that use non-standard encryption methods or require mutual TLS authentication.
247
-
*`http2_enabled` (Boolean)
252
+
-`server_certificates` (String) - Action to take on server certificates. Valid values might include `ALLOW`, `BLOCK`, or `PASS_THRU`.
253
+
-`ocsp_check` (Boolean) - Whether to enable OCSP check.
254
+
-`block_ssl_traffic_with_no_sni_enabled` (Boolean) - Whether to block SSL traffic when SNI is not present.
255
+
-`min_client_tls_version` (String) - The minimum TLS version allowed on the client side: Supported Values are: `CLIENT_TLS_1_0`, `CLIENT_TLS_1_1`, `CLIENT_TLS_1_2`, `CLIENT_TLS_1_3`.
256
+
-`min_server_tls_version` (String) - The minimum TLS version allowed on the server side: Supported Values are: `SERVER_TLS_1_0`, `SERVER_TLS_1_1`, `SERVER_TLS_1_2`, `SERVER_TLS_1_3`.
257
+
-`block_undecrypt` (Boolean) - Enable to block traffic from servers that use non-standard encryption methods or require mutual TLS authentication.
258
+
-`http2_enabled` (Boolean)
259
+
-`ssl_interception_cert` has the following attributes:
260
+
**NOTE** This block can only be set when `override_default_certificate` is `true`
261
+
262
+
-`id` (Integer) - The unique ID of the SSL interception certificate.
248
263
249
264
### do_not_decrypt_sub_actions Attributes
250
265
251
266
`do_not_decrypt_sub_actions` has the following attributes:
252
267
253
-
*`bypass_other_policies` (Boolean) - Whether to bypass other policies when action is set to `DO_NOT_DECRYPT`.
254
-
*`server_certificates` (String) - Action to take on server certificates. Valid values might include `ALLOW`, `BLOCK`, or `PASS_THRU`.
255
-
*`ocsp_check` (Boolean) - Whether to enable OCSP check.
256
-
*`block_ssl_traffic_with_no_sni_enabled` (Boolean) - Whether to block SSL traffic when SNI is not present.
257
-
*`min_tls_version` (String) - The minimum TLS version allowed on the server side: Supported Values are: `SERVER_TLS_1_0`, `SERVER_TLS_1_1`, `SERVER_TLS_1_2`, `SERVER_TLS_1_3`.
268
+
-`bypass_other_policies` (Boolean) - Whether to bypass other policies when action is set to `DO_NOT_DECRYPT`.
269
+
-`server_certificates` (String) - Action to take on server certificates. Valid values might include `ALLOW`, `BLOCK`, or `PASS_THRU`.
270
+
-`ocsp_check` (Boolean) - Whether to enable OCSP check.
271
+
-`block_ssl_traffic_with_no_sni_enabled` (Boolean) - Whether to block SSL traffic when SNI is not present.
272
+
-`min_tls_version` (String) - The minimum TLS version allowed on the server side: Supported Values are: `SERVER_TLS_1_0`, `SERVER_TLS_1_1`, `SERVER_TLS_1_2`, `SERVER_TLS_1_3`.
273
+
**NOTE**`min_tls_version` and `server_certificates` CANNOT be set if `bypass_other_policies` is `true`
258
274
259
275
### Devices Attributes
260
276
261
-
*`id` (Integer) - A unique identifier for the device.
277
+
-`id` (Integer) - A unique identifier for the device.
262
278
263
279
### Device Groups Attributes
264
280
265
-
*`id` (Integer) - A unique identifier for the device groups.
281
+
-`id` (Integer) - A unique identifier for the device groups.
266
282
267
283
### Labels Attributes
268
284
269
-
*`id` (Integer) - A unique identifier for the label.
285
+
-`id` (Integer) - A unique identifier for the label.
270
286
271
287
### Locations Attributes
272
288
273
-
*`id` (Integer) - A unique identifier for the locations.
289
+
-`id` (Integer) - A unique identifier for the locations.
274
290
275
291
### Location Groups Attributes
276
292
277
-
*`id` (Integer) - A unique identifier for the location groups.
293
+
-`id` (Integer) - A unique identifier for the location groups.
278
294
279
295
### Departments Attributes
280
296
281
-
*`id` (Integer) - A unique identifier for the departments.
297
+
-`id` (Integer) - A unique identifier for the departments.
282
298
283
299
### Destination IP Groups Attributes
284
300
285
-
*`id` (Integer) - A unique identifier for the destination ip group.
301
+
-`id` (Integer) - A unique identifier for the destination ip group.
286
302
287
303
### Groups Attributes
288
304
289
-
*`id` (Integer) - A unique identifier for the groups.
305
+
-`id` (Integer) - A unique identifier for the groups.
290
306
291
307
### Source IP Groups Attributes
292
308
293
-
*`id` (Integer) - A unique identifier for the source ip group.
309
+
-`id` (Integer) - A unique identifier for the source ip group.
294
310
295
311
### Users Attributes
296
312
297
-
*`id` (Integer) - A unique identifier for the users.
313
+
-`id` (Integer) - A unique identifier for the users.
298
314
299
315
### Time Windows Attributes
300
316
301
-
*`id` (Integer) - A unique identifier for the time window.
317
+
-`id` (Integer) - A unique identifier for the time window.
302
318
303
319
### Proxy Gateways Attributes
304
320
305
-
*`id` (Integer) - A unique identifier assigned to the Application Segment
321
+
-`id` (Integer) - A unique identifier assigned to the Application Segment
306
322
307
323
### ZPA App Segments Attributes
308
324
309
-
*`id` (Integer) - A unique identifier assigned to the Application Segment
325
+
-`id` (Integer) - A unique identifier assigned to the Application Segment
310
326
311
327
### Workload Groups Attributes
312
328
313
-
*`id` (Integer) - A unique identifier assigned to the workload group
329
+
-`id` (Integer) - A unique identifier assigned to the workload group
0 commit comments