@pulumi/cloudflare 6.10.0-alpha.1759300545 → 6.10.0-alpha.1759443944
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/accessCustomPage.d.ts +12 -0
- package/accessCustomPage.js +12 -0
- package/accessCustomPage.js.map +1 -1
- package/accessServiceToken.d.ts +26 -0
- package/accessServiceToken.js +6 -0
- package/accessServiceToken.js.map +1 -1
- package/addressMap.d.ts +1 -1
- package/botManagement.d.ts +17 -1
- package/botManagement.js +4 -1
- package/botManagement.js.map +1 -1
- package/byoIpPrefix.d.ts +16 -0
- package/byoIpPrefix.js.map +1 -1
- package/dnsFirewall.d.ts +69 -9
- package/dnsFirewall.js.map +1 -1
- package/emailRoutingDns.d.ts +2 -2
- package/emailRoutingDns.js +0 -3
- package/emailRoutingDns.js.map +1 -1
- package/emailSecurityBlockSender.d.ts +3 -3
- package/emailSecurityBlockSender.js +3 -3
- package/emailSecurityTrustedDomains.d.ts +4 -4
- package/emailSecurityTrustedDomains.js +4 -4
- package/getBotManagement.d.ts +5 -0
- package/getBotManagement.js.map +1 -1
- package/getByoIpPrefix.d.ts +8 -0
- package/getByoIpPrefix.js.map +1 -1
- package/getDnsFirewall.d.ts +4 -19
- package/getDnsFirewall.js.map +1 -1
- package/getLoadBalancerPool.d.ts +4 -0
- package/getLoadBalancerPool.js.map +1 -1
- package/getPageShieldConnectionsList.d.ts +3 -3
- package/getPageShieldCookiesList.d.ts +3 -3
- package/getPageShieldScriptsList.d.ts +3 -3
- package/getWorker.d.ts +6 -6
- package/getWorker.js +2 -2
- package/getWorkerVersion.d.ts +19 -46
- package/getWorkerVersion.js +4 -4
- package/getWorkerVersion.js.map +1 -1
- package/getWorkerVersions.d.ts +5 -5
- package/getWorkerVersions.js +2 -2
- package/getWorkflow.d.ts +66 -0
- package/getWorkflow.js +52 -0
- package/getWorkflow.js.map +1 -0
- package/getWorkflows.d.ts +80 -0
- package/getWorkflows.js +52 -0
- package/getWorkflows.js.map +1 -0
- package/getZeroTrustAccessApplication.d.ts +0 -2
- package/getZeroTrustAccessApplication.js.map +1 -1
- package/getZeroTrustAccessCustomPage.d.ts +0 -6
- package/getZeroTrustAccessCustomPage.js.map +1 -1
- package/getZeroTrustAccessGroup.d.ts +0 -2
- package/getZeroTrustAccessGroup.js.map +1 -1
- package/getZeroTrustAccessMtlsCertificate.d.ts +0 -2
- package/getZeroTrustAccessMtlsCertificate.js.map +1 -1
- package/getZeroTrustAccessServiceToken.d.ts +0 -3
- package/getZeroTrustAccessServiceToken.js.map +1 -1
- package/getZeroTrustAccessTag.d.ts +0 -6
- package/getZeroTrustAccessTag.js.map +1 -1
- package/getZeroTrustDnsLocation.d.ts +11 -11
- package/getZeroTrustGatewayAppTypesList.d.ts +3 -3
- package/getZeroTrustGatewayCategoriesList.d.ts +3 -3
- package/getZeroTrustGatewayCertificate.d.ts +11 -11
- package/getZeroTrustGatewayLogging.d.ts +2 -2
- package/getZeroTrustGatewayPolicy.d.ts +36 -10
- package/getZeroTrustGatewayPolicy.js.map +1 -1
- package/getZeroTrustGatewayProxyEndpoint.d.ts +3 -3
- package/getZeroTrustGatewaySettings.d.ts +3 -0
- package/getZeroTrustGatewaySettings.js.map +1 -1
- package/getZeroTrustList.d.ts +9 -9
- package/getZeroTrustLists.d.ts +3 -3
- package/getZeroTrustNetworkHostnameRoute.d.ts +101 -0
- package/getZeroTrustNetworkHostnameRoute.js +52 -0
- package/getZeroTrustNetworkHostnameRoute.js.map +1 -0
- package/getZeroTrustNetworkHostnameRoutes.d.ts +153 -0
- package/getZeroTrustNetworkHostnameRoutes.js +70 -0
- package/getZeroTrustNetworkHostnameRoutes.js.map +1 -0
- package/getZeroTrustOrganization.d.ts +0 -2
- package/getZeroTrustOrganization.js.map +1 -1
- package/index.d.ts +18 -0
- package/index.js +29 -7
- package/index.js.map +1 -1
- package/listItem.d.ts +4 -0
- package/listItem.js +4 -0
- package/listItem.js.map +1 -1
- package/loadBalancerPool.d.ts +12 -0
- package/loadBalancerPool.js +2 -0
- package/loadBalancerPool.js.map +1 -1
- package/package.json +2 -2
- package/r2customDomain.d.ts +2 -2
- package/r2customDomain.js +2 -2
- package/teamsAccount.d.ts +3 -3
- package/teamsList.d.ts +14 -14
- package/teamsLocation.d.ts +28 -28
- package/teamsProxyEndpoint.d.ts +8 -8
- package/teamsRule.d.ts +39 -51
- package/teamsRule.js +2 -2
- package/teamsRule.js.map +1 -1
- package/types/input.d.ts +522 -359
- package/types/output.d.ts +975 -740
- package/workerScript.d.ts +12 -12
- package/workerVersion.d.ts +18 -3
- package/workerVersion.js.map +1 -1
- package/workersScript.d.ts +12 -12
- package/workersScriptSubdomain.d.ts +2 -2
- package/workersScriptSubdomain.js +1 -1
- package/workflow.d.ts +87 -0
- package/workflow.js +104 -0
- package/workflow.js.map +1 -0
- package/zeroTrustAccessCustomPage.d.ts +12 -0
- package/zeroTrustAccessCustomPage.js +12 -0
- package/zeroTrustAccessCustomPage.js.map +1 -1
- package/zeroTrustAccessServiceToken.d.ts +26 -0
- package/zeroTrustAccessServiceToken.js +6 -0
- package/zeroTrustAccessServiceToken.js.map +1 -1
- package/zeroTrustDexTest.d.ts +2 -27
- package/zeroTrustDexTest.js +1 -25
- package/zeroTrustDexTest.js.map +1 -1
- package/zeroTrustDnsLocation.d.ts +28 -28
- package/zeroTrustGatewayCertificate.d.ts +26 -14
- package/zeroTrustGatewayCertificate.js +2 -0
- package/zeroTrustGatewayCertificate.js.map +1 -1
- package/zeroTrustGatewayLogging.d.ts +6 -6
- package/zeroTrustGatewayPolicy.d.ts +39 -51
- package/zeroTrustGatewayPolicy.js +2 -2
- package/zeroTrustGatewayPolicy.js.map +1 -1
- package/zeroTrustGatewayProxyEndpoint.d.ts +8 -8
- package/zeroTrustGatewaySettings.d.ts +3 -3
- package/zeroTrustList.d.ts +14 -14
- package/zeroTrustNetworkHostnameRoute.d.ts +129 -0
- package/zeroTrustNetworkHostnameRoute.js +85 -0
- package/zeroTrustNetworkHostnameRoute.js.map +1 -0
package/types/output.d.ts
CHANGED
|
@@ -813,7 +813,6 @@ export interface AccessApplicationSaasApp {
|
|
|
813
813
|
* The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
|
|
814
814
|
*/
|
|
815
815
|
consumerServiceUrl?: string;
|
|
816
|
-
createdAt: string;
|
|
817
816
|
customAttributes?: outputs.AccessApplicationSaasAppCustomAttribute[];
|
|
818
817
|
customClaims?: outputs.AccessApplicationSaasAppCustomClaim[];
|
|
819
818
|
/**
|
|
@@ -867,7 +866,6 @@ export interface AccessApplicationSaasApp {
|
|
|
867
866
|
* The endpoint where your SaaS application will send login requests.
|
|
868
867
|
*/
|
|
869
868
|
ssoEndpoint: string;
|
|
870
|
-
updatedAt: string;
|
|
871
869
|
}
|
|
872
870
|
export interface AccessApplicationSaasAppCustomAttribute {
|
|
873
871
|
/**
|
|
@@ -2633,37 +2631,37 @@ export interface AccountDnsSettingsZoneDefaultsNameservers {
|
|
|
2633
2631
|
* Nameserver type
|
|
2634
2632
|
* Available values: "cloudflare.standard", "cloudflare.standard.random", "custom.account", "custom.tenant".
|
|
2635
2633
|
*/
|
|
2636
|
-
type
|
|
2634
|
+
type?: string;
|
|
2637
2635
|
}
|
|
2638
2636
|
export interface AccountDnsSettingsZoneDefaultsSoa {
|
|
2639
2637
|
/**
|
|
2640
2638
|
* Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
|
|
2641
2639
|
*/
|
|
2642
|
-
expire
|
|
2640
|
+
expire?: number;
|
|
2643
2641
|
/**
|
|
2644
2642
|
* The time to live (TTL) for negative caching of records within the zone.
|
|
2645
2643
|
*/
|
|
2646
|
-
minTtl
|
|
2644
|
+
minTtl?: number;
|
|
2647
2645
|
/**
|
|
2648
|
-
* The primary nameserver, which may be used for outbound zone transfers.
|
|
2646
|
+
* The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
|
|
2649
2647
|
*/
|
|
2650
|
-
mname
|
|
2648
|
+
mname?: string;
|
|
2651
2649
|
/**
|
|
2652
2650
|
* Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
|
|
2653
2651
|
*/
|
|
2654
|
-
refresh
|
|
2652
|
+
refresh?: number;
|
|
2655
2653
|
/**
|
|
2656
2654
|
* Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
|
|
2657
2655
|
*/
|
|
2658
|
-
retry
|
|
2656
|
+
retry?: number;
|
|
2659
2657
|
/**
|
|
2660
2658
|
* The email address of the zone administrator, with the first label representing the local part of the email address.
|
|
2661
2659
|
*/
|
|
2662
|
-
rname
|
|
2660
|
+
rname?: string;
|
|
2663
2661
|
/**
|
|
2664
2662
|
* The time to live (TTL) of the SOA record itself.
|
|
2665
2663
|
*/
|
|
2666
|
-
ttl
|
|
2664
|
+
ttl?: number;
|
|
2667
2665
|
}
|
|
2668
2666
|
export interface AccountMemberPolicy {
|
|
2669
2667
|
/**
|
|
@@ -2822,11 +2820,6 @@ export interface AccountUnit {
|
|
|
2822
2820
|
id?: string;
|
|
2823
2821
|
}
|
|
2824
2822
|
export interface AddressMapMembership {
|
|
2825
|
-
/**
|
|
2826
|
-
* Controls whether the membership can be deleted via the API or not.
|
|
2827
|
-
*/
|
|
2828
|
-
canDelete: boolean;
|
|
2829
|
-
createdAt: string;
|
|
2830
2823
|
/**
|
|
2831
2824
|
* The identifier for the membership (eg. a zone or account tag).
|
|
2832
2825
|
*/
|
|
@@ -4394,7 +4387,7 @@ export interface GetAccountDnsSettingsZoneDefaultsSoa {
|
|
|
4394
4387
|
*/
|
|
4395
4388
|
minTtl: number;
|
|
4396
4389
|
/**
|
|
4397
|
-
* The primary nameserver, which may be used for outbound zone transfers.
|
|
4390
|
+
* The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
|
|
4398
4391
|
*/
|
|
4399
4392
|
mname: string;
|
|
4400
4393
|
/**
|
|
@@ -5947,10 +5940,14 @@ export interface GetByoIpPrefixesResult {
|
|
|
5947
5940
|
accountId: string;
|
|
5948
5941
|
/**
|
|
5949
5942
|
* Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
|
|
5943
|
+
*
|
|
5944
|
+
* @deprecated Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.
|
|
5950
5945
|
*/
|
|
5951
5946
|
advertised: boolean;
|
|
5952
5947
|
/**
|
|
5953
5948
|
* Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
|
|
5949
|
+
*
|
|
5950
|
+
* @deprecated Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.
|
|
5954
5951
|
*/
|
|
5955
5952
|
advertisedModifiedAt: string;
|
|
5956
5953
|
/**
|
|
@@ -5981,10 +5978,14 @@ export interface GetByoIpPrefixesResult {
|
|
|
5981
5978
|
modifiedAt: string;
|
|
5982
5979
|
/**
|
|
5983
5980
|
* Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
|
|
5981
|
+
*
|
|
5982
|
+
* @deprecated Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.
|
|
5984
5983
|
*/
|
|
5985
5984
|
onDemandEnabled: boolean;
|
|
5986
5985
|
/**
|
|
5987
5986
|
* Whether advertisement status of the prefix is locked, meaning it cannot be changed.
|
|
5987
|
+
*
|
|
5988
|
+
* @deprecated Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix.
|
|
5988
5989
|
*/
|
|
5989
5990
|
onDemandLocked: boolean;
|
|
5990
5991
|
}
|
|
@@ -6794,11 +6795,26 @@ export interface GetDnsFirewallsResult {
|
|
|
6794
6795
|
*/
|
|
6795
6796
|
id: string;
|
|
6796
6797
|
/**
|
|
6797
|
-
*
|
|
6798
|
+
* By default, Cloudflare attempts to cache responses for as long as
|
|
6799
|
+
* indicated by the TTL received from upstream nameservers. This setting
|
|
6800
|
+
* sets an upper bound on this duration. For caching purposes, higher TTLs
|
|
6801
|
+
* will be decreased to the maximum value defined by this setting.
|
|
6798
6802
|
*/
|
|
6799
6803
|
maximumCacheTtl: number;
|
|
6800
6804
|
/**
|
|
6801
|
-
*
|
|
6805
|
+
* By default, Cloudflare attempts to cache responses for as long as
|
|
6806
|
+
* indicated by the TTL received from upstream nameservers. This setting
|
|
6807
|
+
* sets a lower bound on this duration. For caching purposes, lower TTLs
|
|
6808
|
+
* will be increased to the minimum value defined by this setting.
|
|
6809
|
+
*
|
|
6810
|
+
* This setting does not affect the TTL value in the DNS response
|
|
6811
|
+
* Cloudflare returns to clients. Cloudflare will always forward the TTL
|
|
6812
|
+
* value received from upstream nameservers.
|
|
6813
|
+
*
|
|
6814
|
+
* Note that, even with this setting, there is no guarantee that a
|
|
6815
|
+
* response will be cached for at least the specified duration. Cached
|
|
6816
|
+
* responses may be removed earlier for capacity or other operational
|
|
6817
|
+
* reasons.
|
|
6802
6818
|
*/
|
|
6803
6819
|
minimumCacheTtl: number;
|
|
6804
6820
|
/**
|
|
@@ -6810,7 +6826,12 @@ export interface GetDnsFirewallsResult {
|
|
|
6810
6826
|
*/
|
|
6811
6827
|
name: string;
|
|
6812
6828
|
/**
|
|
6813
|
-
*
|
|
6829
|
+
* This setting controls how long DNS Firewall should cache negative
|
|
6830
|
+
* responses (e.g., NXDOMAIN) from the upstream servers.
|
|
6831
|
+
*
|
|
6832
|
+
* This setting does not affect the TTL value in the DNS response
|
|
6833
|
+
* Cloudflare returns to clients. Cloudflare will always forward the TTL
|
|
6834
|
+
* value received from upstream nameservers.
|
|
6814
6835
|
*/
|
|
6815
6836
|
negativeCacheTtl: number;
|
|
6816
6837
|
/**
|
|
@@ -8780,6 +8801,10 @@ export interface GetLoadBalancerPoolsResult {
|
|
|
8780
8801
|
* The ID of the Monitor to use for checking the health of origins within this pool.
|
|
8781
8802
|
*/
|
|
8782
8803
|
monitor: string;
|
|
8804
|
+
/**
|
|
8805
|
+
* The ID of the Monitor Group to use for checking the health of origins within this pool.
|
|
8806
|
+
*/
|
|
8807
|
+
monitorGroup: string;
|
|
8783
8808
|
/**
|
|
8784
8809
|
* A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
|
|
8785
8810
|
*/
|
|
@@ -10109,6 +10134,10 @@ export interface GetMagicTransitSitesResultLocation {
|
|
|
10109
10134
|
lon: string;
|
|
10110
10135
|
}
|
|
10111
10136
|
export interface GetMagicWanGreTunnelGreTunnel {
|
|
10137
|
+
/**
|
|
10138
|
+
* True if automatic stateful return routing should be enabled for a tunnel, false otherwise.
|
|
10139
|
+
*/
|
|
10140
|
+
automaticReturnRouting: boolean;
|
|
10112
10141
|
bgp: outputs.GetMagicWanGreTunnelGreTunnelBgp;
|
|
10113
10142
|
bgpStatus: outputs.GetMagicWanGreTunnelGreTunnelBgpStatus;
|
|
10114
10143
|
/**
|
|
@@ -10224,6 +10253,10 @@ export interface GetMagicWanIpsecTunnelIpsecTunnel {
|
|
|
10224
10253
|
* When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).
|
|
10225
10254
|
*/
|
|
10226
10255
|
allowNullCipher: boolean;
|
|
10256
|
+
/**
|
|
10257
|
+
* True if automatic stateful return routing should be enabled for a tunnel, false otherwise.
|
|
10258
|
+
*/
|
|
10259
|
+
automaticReturnRouting: boolean;
|
|
10227
10260
|
bgp: outputs.GetMagicWanIpsecTunnelIpsecTunnelBgp;
|
|
10228
10261
|
bgpStatus: outputs.GetMagicWanIpsecTunnelIpsecTunnelBgpStatus;
|
|
10229
10262
|
/**
|
|
@@ -10234,6 +10267,7 @@ export interface GetMagicWanIpsecTunnelIpsecTunnel {
|
|
|
10234
10267
|
* The date and time the tunnel was created.
|
|
10235
10268
|
*/
|
|
10236
10269
|
createdOn: string;
|
|
10270
|
+
customRemoteIdentities: outputs.GetMagicWanIpsecTunnelIpsecTunnelCustomRemoteIdentities;
|
|
10237
10271
|
/**
|
|
10238
10272
|
* The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work.
|
|
10239
10273
|
*/
|
|
@@ -10299,6 +10333,13 @@ export interface GetMagicWanIpsecTunnelIpsecTunnelBgpStatus {
|
|
|
10299
10333
|
tcpEstablished: boolean;
|
|
10300
10334
|
updatedAt: string;
|
|
10301
10335
|
}
|
|
10336
|
+
export interface GetMagicWanIpsecTunnelIpsecTunnelCustomRemoteIdentities {
|
|
10337
|
+
/**
|
|
10338
|
+
* A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
|
|
10339
|
+
* generated IKE IDs can still be used even if this custom value is specified.
|
|
10340
|
+
*/
|
|
10341
|
+
fqdnId: string;
|
|
10342
|
+
}
|
|
10302
10343
|
export interface GetMagicWanIpsecTunnelIpsecTunnelHealthCheck {
|
|
10303
10344
|
/**
|
|
10304
10345
|
* The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.
|
|
@@ -14988,6 +15029,14 @@ export interface GetWorkerVersionBinding {
|
|
|
14988
15029
|
* Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
|
|
14989
15030
|
*/
|
|
14990
15031
|
algorithm: string;
|
|
15032
|
+
/**
|
|
15033
|
+
* List of allowed destination addresses.
|
|
15034
|
+
*/
|
|
15035
|
+
allowedDestinationAddresses: string[];
|
|
15036
|
+
/**
|
|
15037
|
+
* List of allowed sender addresses.
|
|
15038
|
+
*/
|
|
15039
|
+
allowedSenderAddresses: string[];
|
|
14991
15040
|
/**
|
|
14992
15041
|
* R2 bucket to bind to.
|
|
14993
15042
|
*/
|
|
@@ -15004,6 +15053,10 @@ export interface GetWorkerVersionBinding {
|
|
|
15004
15053
|
* The name of the dataset to bind to.
|
|
15005
15054
|
*/
|
|
15006
15055
|
dataset: string;
|
|
15056
|
+
/**
|
|
15057
|
+
* Destination address for the email.
|
|
15058
|
+
*/
|
|
15059
|
+
destinationAddress: string;
|
|
15007
15060
|
/**
|
|
15008
15061
|
* The environment of the scriptName to bind to.
|
|
15009
15062
|
*/
|
|
@@ -15025,6 +15078,11 @@ export interface GetWorkerVersionBinding {
|
|
|
15025
15078
|
* JSON data to use.
|
|
15026
15079
|
*/
|
|
15027
15080
|
json: string;
|
|
15081
|
+
/**
|
|
15082
|
+
* The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket.
|
|
15083
|
+
* Available values: "eu", "fedramp".
|
|
15084
|
+
*/
|
|
15085
|
+
jurisdiction: string;
|
|
15028
15086
|
/**
|
|
15029
15087
|
* Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
|
|
15030
15088
|
*/
|
|
@@ -15045,10 +15103,18 @@ export interface GetWorkerVersionBinding {
|
|
|
15045
15103
|
* Namespace identifier tag.
|
|
15046
15104
|
*/
|
|
15047
15105
|
namespaceId: string;
|
|
15106
|
+
/**
|
|
15107
|
+
* The old name of the inherited binding. If set, the binding will be renamed from `oldName` to `name` in the new version. If not set, the binding will keep the same name between versions.
|
|
15108
|
+
*/
|
|
15109
|
+
oldName: string;
|
|
15048
15110
|
/**
|
|
15049
15111
|
* Outbound worker.
|
|
15050
15112
|
*/
|
|
15051
15113
|
outbound: outputs.GetWorkerVersionBindingOutbound;
|
|
15114
|
+
/**
|
|
15115
|
+
* The name of the file containing the data content. Only accepted for `service worker syntax` Workers.
|
|
15116
|
+
*/
|
|
15117
|
+
part: string;
|
|
15052
15118
|
/**
|
|
15053
15119
|
* Name of the Pipeline to bind to.
|
|
15054
15120
|
*/
|
|
@@ -15079,13 +15145,17 @@ export interface GetWorkerVersionBinding {
|
|
|
15079
15145
|
text: string;
|
|
15080
15146
|
/**
|
|
15081
15147
|
* The kind of resource that the binding provides.
|
|
15082
|
-
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "service", "tail*consumer", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow".
|
|
15148
|
+
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "data*blob", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "inherit", "images", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "send*email", "service", "tail*consumer", "text*blob", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow", "wasm*module".
|
|
15083
15149
|
*/
|
|
15084
15150
|
type: string;
|
|
15085
15151
|
/**
|
|
15086
15152
|
* Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
|
|
15087
15153
|
*/
|
|
15088
15154
|
usages: string[];
|
|
15155
|
+
/**
|
|
15156
|
+
* Identifier for the version to inherit the binding from, which can be the version ID or the literal "latest" to inherit from the latest version. Defaults to inheriting the binding from the latest version.
|
|
15157
|
+
*/
|
|
15158
|
+
versionId: string;
|
|
15089
15159
|
/**
|
|
15090
15160
|
* Name of the Workflow to bind to.
|
|
15091
15161
|
*/
|
|
@@ -15255,6 +15325,11 @@ export interface GetWorkerVersionsResult {
|
|
|
15255
15325
|
migrations: outputs.GetWorkerVersionsResultMigrations;
|
|
15256
15326
|
/**
|
|
15257
15327
|
* Code, sourcemaps, and other content used at runtime.
|
|
15328
|
+
*
|
|
15329
|
+
* This includes [`_headers`](https://developers.cloudflare.com/workers/static-assets/headers/#custom-headers) and
|
|
15330
|
+
* [`_redirects`](https://developers.cloudflare.com/workers/static-assets/redirects/) files used to configure
|
|
15331
|
+
* [Static Assets](https://developers.cloudflare.com/workers/static-assets/). `_headers` and `_redirects` files should be
|
|
15332
|
+
* included as modules named `_headers` and `_redirects` with content type `text/plain`.
|
|
15258
15333
|
*/
|
|
15259
15334
|
modules: outputs.GetWorkerVersionsResultModule[];
|
|
15260
15335
|
/**
|
|
@@ -15322,6 +15397,14 @@ export interface GetWorkerVersionsResultBinding {
|
|
|
15322
15397
|
* Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
|
|
15323
15398
|
*/
|
|
15324
15399
|
algorithm: string;
|
|
15400
|
+
/**
|
|
15401
|
+
* List of allowed destination addresses.
|
|
15402
|
+
*/
|
|
15403
|
+
allowedDestinationAddresses: string[];
|
|
15404
|
+
/**
|
|
15405
|
+
* List of allowed sender addresses.
|
|
15406
|
+
*/
|
|
15407
|
+
allowedSenderAddresses: string[];
|
|
15325
15408
|
/**
|
|
15326
15409
|
* R2 bucket to bind to.
|
|
15327
15410
|
*/
|
|
@@ -15338,6 +15421,10 @@ export interface GetWorkerVersionsResultBinding {
|
|
|
15338
15421
|
* The name of the dataset to bind to.
|
|
15339
15422
|
*/
|
|
15340
15423
|
dataset: string;
|
|
15424
|
+
/**
|
|
15425
|
+
* Destination address for the email.
|
|
15426
|
+
*/
|
|
15427
|
+
destinationAddress: string;
|
|
15341
15428
|
/**
|
|
15342
15429
|
* The environment of the scriptName to bind to.
|
|
15343
15430
|
*/
|
|
@@ -15359,6 +15446,11 @@ export interface GetWorkerVersionsResultBinding {
|
|
|
15359
15446
|
* JSON data to use.
|
|
15360
15447
|
*/
|
|
15361
15448
|
json: string;
|
|
15449
|
+
/**
|
|
15450
|
+
* The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket.
|
|
15451
|
+
* Available values: "eu", "fedramp".
|
|
15452
|
+
*/
|
|
15453
|
+
jurisdiction: string;
|
|
15362
15454
|
/**
|
|
15363
15455
|
* Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
|
|
15364
15456
|
*/
|
|
@@ -15379,10 +15471,18 @@ export interface GetWorkerVersionsResultBinding {
|
|
|
15379
15471
|
* Namespace identifier tag.
|
|
15380
15472
|
*/
|
|
15381
15473
|
namespaceId: string;
|
|
15474
|
+
/**
|
|
15475
|
+
* The old name of the inherited binding. If set, the binding will be renamed from `oldName` to `name` in the new version. If not set, the binding will keep the same name between versions.
|
|
15476
|
+
*/
|
|
15477
|
+
oldName: string;
|
|
15382
15478
|
/**
|
|
15383
15479
|
* Outbound worker.
|
|
15384
15480
|
*/
|
|
15385
15481
|
outbound: outputs.GetWorkerVersionsResultBindingOutbound;
|
|
15482
|
+
/**
|
|
15483
|
+
* The name of the file containing the data content. Only accepted for `service worker syntax` Workers.
|
|
15484
|
+
*/
|
|
15485
|
+
part: string;
|
|
15386
15486
|
/**
|
|
15387
15487
|
* Name of the Pipeline to bind to.
|
|
15388
15488
|
*/
|
|
@@ -15413,13 +15513,17 @@ export interface GetWorkerVersionsResultBinding {
|
|
|
15413
15513
|
text: string;
|
|
15414
15514
|
/**
|
|
15415
15515
|
* The kind of resource that the binding provides.
|
|
15416
|
-
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "service", "tail*consumer", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow".
|
|
15516
|
+
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "data*blob", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "inherit", "images", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "send*email", "service", "tail*consumer", "text*blob", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow", "wasm*module".
|
|
15417
15517
|
*/
|
|
15418
15518
|
type: string;
|
|
15419
15519
|
/**
|
|
15420
15520
|
* Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
|
|
15421
15521
|
*/
|
|
15422
15522
|
usages: string[];
|
|
15523
|
+
/**
|
|
15524
|
+
* Identifier for the version to inherit the binding from, which can be the version ID or the literal "latest" to inherit from the latest version. Defaults to inheriting the binding from the latest version.
|
|
15525
|
+
*/
|
|
15526
|
+
versionId: string;
|
|
15423
15527
|
/**
|
|
15424
15528
|
* Name of the Workflow to bind to.
|
|
15425
15529
|
*/
|
|
@@ -15679,7 +15783,7 @@ export interface GetWorkersResult {
|
|
|
15679
15783
|
*/
|
|
15680
15784
|
createdOn: string;
|
|
15681
15785
|
/**
|
|
15682
|
-
*
|
|
15786
|
+
* Immutable ID of the Worker.
|
|
15683
15787
|
*/
|
|
15684
15788
|
id: string;
|
|
15685
15789
|
/**
|
|
@@ -15890,6 +15994,42 @@ export interface GetWorkersScriptsResultTailConsumer {
|
|
|
15890
15994
|
*/
|
|
15891
15995
|
service: string;
|
|
15892
15996
|
}
|
|
15997
|
+
export interface GetWorkflowFilter {
|
|
15998
|
+
/**
|
|
15999
|
+
* Allows filtering workflows` name.
|
|
16000
|
+
*/
|
|
16001
|
+
search?: string;
|
|
16002
|
+
}
|
|
16003
|
+
export interface GetWorkflowInstances {
|
|
16004
|
+
complete: number;
|
|
16005
|
+
errored: number;
|
|
16006
|
+
paused: number;
|
|
16007
|
+
queued: number;
|
|
16008
|
+
running: number;
|
|
16009
|
+
terminated: number;
|
|
16010
|
+
waiting: number;
|
|
16011
|
+
waitingForPause: number;
|
|
16012
|
+
}
|
|
16013
|
+
export interface GetWorkflowsResult {
|
|
16014
|
+
className: string;
|
|
16015
|
+
createdOn: string;
|
|
16016
|
+
id: string;
|
|
16017
|
+
instances: outputs.GetWorkflowsResultInstances;
|
|
16018
|
+
modifiedOn: string;
|
|
16019
|
+
name: string;
|
|
16020
|
+
scriptName: string;
|
|
16021
|
+
triggeredOn: string;
|
|
16022
|
+
}
|
|
16023
|
+
export interface GetWorkflowsResultInstances {
|
|
16024
|
+
complete: number;
|
|
16025
|
+
errored: number;
|
|
16026
|
+
paused: number;
|
|
16027
|
+
queued: number;
|
|
16028
|
+
running: number;
|
|
16029
|
+
terminated: number;
|
|
16030
|
+
waiting: number;
|
|
16031
|
+
waitingForPause: number;
|
|
16032
|
+
}
|
|
15893
16033
|
export interface GetZeroTrustAccessApplicationCorsHeaders {
|
|
15894
16034
|
/**
|
|
15895
16035
|
* Allows all HTTP request headers.
|
|
@@ -16766,7 +16906,6 @@ export interface GetZeroTrustAccessApplicationSaasApp {
|
|
|
16766
16906
|
* The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
|
|
16767
16907
|
*/
|
|
16768
16908
|
consumerServiceUrl: string;
|
|
16769
|
-
createdAt: string;
|
|
16770
16909
|
customAttributes: outputs.GetZeroTrustAccessApplicationSaasAppCustomAttribute[];
|
|
16771
16910
|
customClaims: outputs.GetZeroTrustAccessApplicationSaasAppCustomClaim[];
|
|
16772
16911
|
/**
|
|
@@ -16820,7 +16959,6 @@ export interface GetZeroTrustAccessApplicationSaasApp {
|
|
|
16820
16959
|
* The endpoint where your SaaS application will send login requests.
|
|
16821
16960
|
*/
|
|
16822
16961
|
ssoEndpoint: string;
|
|
16823
|
-
updatedAt: string;
|
|
16824
16962
|
}
|
|
16825
16963
|
export interface GetZeroTrustAccessApplicationSaasAppCustomAttribute {
|
|
16826
16964
|
/**
|
|
@@ -17063,7 +17201,6 @@ export interface GetZeroTrustAccessApplicationsResult {
|
|
|
17063
17201
|
*/
|
|
17064
17202
|
bgColor: string;
|
|
17065
17203
|
corsHeaders: outputs.GetZeroTrustAccessApplicationsResultCorsHeaders;
|
|
17066
|
-
createdAt: string;
|
|
17067
17204
|
/**
|
|
17068
17205
|
* The custom error message shown to a user when they are denied access to the application.
|
|
17069
17206
|
*/
|
|
@@ -17180,7 +17317,6 @@ export interface GetZeroTrustAccessApplicationsResult {
|
|
|
17180
17317
|
* Available values: "self*hosted", "saas", "ssh", "vnc", "app*launcher", "warp", "biso", "bookmark", "dashSso", "infrastructure", "rdp".
|
|
17181
17318
|
*/
|
|
17182
17319
|
type: string;
|
|
17183
|
-
updatedAt: string;
|
|
17184
17320
|
}
|
|
17185
17321
|
export interface GetZeroTrustAccessApplicationsResultCorsHeaders {
|
|
17186
17322
|
/**
|
|
@@ -18036,7 +18172,6 @@ export interface GetZeroTrustAccessApplicationsResultSaasApp {
|
|
|
18036
18172
|
* The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
|
|
18037
18173
|
*/
|
|
18038
18174
|
consumerServiceUrl: string;
|
|
18039
|
-
createdAt: string;
|
|
18040
18175
|
customAttributes: outputs.GetZeroTrustAccessApplicationsResultSaasAppCustomAttribute[];
|
|
18041
18176
|
customClaims: outputs.GetZeroTrustAccessApplicationsResultSaasAppCustomClaim[];
|
|
18042
18177
|
/**
|
|
@@ -18090,7 +18225,6 @@ export interface GetZeroTrustAccessApplicationsResultSaasApp {
|
|
|
18090
18225
|
* The endpoint where your SaaS application will send login requests.
|
|
18091
18226
|
*/
|
|
18092
18227
|
ssoEndpoint: string;
|
|
18093
|
-
updatedAt: string;
|
|
18094
18228
|
}
|
|
18095
18229
|
export interface GetZeroTrustAccessApplicationsResultSaasAppCustomAttribute {
|
|
18096
18230
|
/**
|
|
@@ -18300,11 +18434,6 @@ export interface GetZeroTrustAccessApplicationsResultTargetCriteria {
|
|
|
18300
18434
|
};
|
|
18301
18435
|
}
|
|
18302
18436
|
export interface GetZeroTrustAccessCustomPagesResult {
|
|
18303
|
-
/**
|
|
18304
|
-
* Number of apps the custom page is assigned to.
|
|
18305
|
-
*/
|
|
18306
|
-
appCount: number;
|
|
18307
|
-
createdAt: string;
|
|
18308
18437
|
/**
|
|
18309
18438
|
* Custom page name.
|
|
18310
18439
|
*/
|
|
@@ -18318,7 +18447,6 @@ export interface GetZeroTrustAccessCustomPagesResult {
|
|
|
18318
18447
|
* UUID.
|
|
18319
18448
|
*/
|
|
18320
18449
|
uid: string;
|
|
18321
|
-
updatedAt: string;
|
|
18322
18450
|
}
|
|
18323
18451
|
export interface GetZeroTrustAccessGroupExclude {
|
|
18324
18452
|
/**
|
|
@@ -19179,7 +19307,6 @@ export interface GetZeroTrustAccessGroupRequireServiceToken {
|
|
|
19179
19307
|
tokenId: string;
|
|
19180
19308
|
}
|
|
19181
19309
|
export interface GetZeroTrustAccessGroupsResult {
|
|
19182
|
-
createdAt: string;
|
|
19183
19310
|
/**
|
|
19184
19311
|
* Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.
|
|
19185
19312
|
*/
|
|
@@ -19204,7 +19331,6 @@ export interface GetZeroTrustAccessGroupsResult {
|
|
|
19204
19331
|
* Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
|
|
19205
19332
|
*/
|
|
19206
19333
|
requires: outputs.GetZeroTrustAccessGroupsResultRequire[];
|
|
19207
|
-
updatedAt: string;
|
|
19208
19334
|
}
|
|
19209
19335
|
export interface GetZeroTrustAccessGroupsResultExclude {
|
|
19210
19336
|
/**
|
|
@@ -20551,7 +20677,6 @@ export interface GetZeroTrustAccessMtlsCertificatesResult {
|
|
|
20551
20677
|
* The hostnames of the applications that will use this certificate.
|
|
20552
20678
|
*/
|
|
20553
20679
|
associatedHostnames: string[];
|
|
20554
|
-
createdAt: string;
|
|
20555
20680
|
expiresOn: string;
|
|
20556
20681
|
/**
|
|
20557
20682
|
* The MD5 fingerprint of the certificate.
|
|
@@ -20565,7 +20690,6 @@ export interface GetZeroTrustAccessMtlsCertificatesResult {
|
|
|
20565
20690
|
* The name of the certificate.
|
|
20566
20691
|
*/
|
|
20567
20692
|
name: string;
|
|
20568
|
-
updatedAt: string;
|
|
20569
20693
|
}
|
|
20570
20694
|
export interface GetZeroTrustAccessPoliciesResult {
|
|
20571
20695
|
/**
|
|
@@ -21940,7 +22064,6 @@ export interface GetZeroTrustAccessServiceTokensResult {
|
|
|
21940
22064
|
* The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header.
|
|
21941
22065
|
*/
|
|
21942
22066
|
clientId: string;
|
|
21943
|
-
createdAt: string;
|
|
21944
22067
|
/**
|
|
21945
22068
|
* The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in hours (8760h).
|
|
21946
22069
|
*/
|
|
@@ -21950,12 +22073,10 @@ export interface GetZeroTrustAccessServiceTokensResult {
|
|
|
21950
22073
|
* The ID of the service token.
|
|
21951
22074
|
*/
|
|
21952
22075
|
id: string;
|
|
21953
|
-
lastSeenAt: string;
|
|
21954
22076
|
/**
|
|
21955
22077
|
* The name of the service token.
|
|
21956
22078
|
*/
|
|
21957
22079
|
name: string;
|
|
21958
|
-
updatedAt: string;
|
|
21959
22080
|
}
|
|
21960
22081
|
export interface GetZeroTrustAccessShortLivedCertificatesResult {
|
|
21961
22082
|
/**
|
|
@@ -21972,16 +22093,10 @@ export interface GetZeroTrustAccessShortLivedCertificatesResult {
|
|
|
21972
22093
|
publicKey: string;
|
|
21973
22094
|
}
|
|
21974
22095
|
export interface GetZeroTrustAccessTagsResult {
|
|
21975
|
-
/**
|
|
21976
|
-
* The number of applications that have this tag
|
|
21977
|
-
*/
|
|
21978
|
-
appCount: number;
|
|
21979
|
-
createdAt: string;
|
|
21980
22096
|
/**
|
|
21981
22097
|
* The name of the tag
|
|
21982
22098
|
*/
|
|
21983
22099
|
name: string;
|
|
21984
|
-
updatedAt: string;
|
|
21985
22100
|
}
|
|
21986
22101
|
export interface GetZeroTrustDeviceCustomProfileExclude {
|
|
21987
22102
|
/**
|
|
@@ -23379,113 +23494,113 @@ export interface GetZeroTrustDnsLocationEndpoints {
|
|
|
23379
23494
|
}
|
|
23380
23495
|
export interface GetZeroTrustDnsLocationEndpointsDoh {
|
|
23381
23496
|
/**
|
|
23382
|
-
*
|
|
23497
|
+
* Indicate whether the DOH endpoint is enabled for this location.
|
|
23383
23498
|
*/
|
|
23384
23499
|
enabled: boolean;
|
|
23385
23500
|
/**
|
|
23386
|
-
*
|
|
23501
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
23387
23502
|
*/
|
|
23388
23503
|
networks: outputs.GetZeroTrustDnsLocationEndpointsDohNetwork[];
|
|
23389
23504
|
/**
|
|
23390
|
-
*
|
|
23505
|
+
* Specify whether the DOH endpoint requires user identity authentication.
|
|
23391
23506
|
*/
|
|
23392
23507
|
requireToken: boolean;
|
|
23393
23508
|
}
|
|
23394
23509
|
export interface GetZeroTrustDnsLocationEndpointsDohNetwork {
|
|
23395
23510
|
/**
|
|
23396
|
-
*
|
|
23511
|
+
* Specify the IP address or IP CIDR.
|
|
23397
23512
|
*/
|
|
23398
23513
|
network: string;
|
|
23399
23514
|
}
|
|
23400
23515
|
export interface GetZeroTrustDnsLocationEndpointsDot {
|
|
23401
23516
|
/**
|
|
23402
|
-
*
|
|
23517
|
+
* Indicate whether the DOT endpoint is enabled for this location.
|
|
23403
23518
|
*/
|
|
23404
23519
|
enabled: boolean;
|
|
23405
23520
|
/**
|
|
23406
|
-
*
|
|
23521
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
23407
23522
|
*/
|
|
23408
23523
|
networks: outputs.GetZeroTrustDnsLocationEndpointsDotNetwork[];
|
|
23409
23524
|
}
|
|
23410
23525
|
export interface GetZeroTrustDnsLocationEndpointsDotNetwork {
|
|
23411
23526
|
/**
|
|
23412
|
-
*
|
|
23527
|
+
* Specify the IP address or IP CIDR.
|
|
23413
23528
|
*/
|
|
23414
23529
|
network: string;
|
|
23415
23530
|
}
|
|
23416
23531
|
export interface GetZeroTrustDnsLocationEndpointsIpv4 {
|
|
23417
23532
|
/**
|
|
23418
|
-
*
|
|
23533
|
+
* Indicate whether the IPv4 endpoint is enabled for this location.
|
|
23419
23534
|
*/
|
|
23420
23535
|
enabled: boolean;
|
|
23421
23536
|
}
|
|
23422
23537
|
export interface GetZeroTrustDnsLocationEndpointsIpv6 {
|
|
23423
23538
|
/**
|
|
23424
|
-
*
|
|
23539
|
+
* Indicate whether the IPV6 endpoint is enabled for this location.
|
|
23425
23540
|
*/
|
|
23426
23541
|
enabled: boolean;
|
|
23427
23542
|
/**
|
|
23428
|
-
*
|
|
23543
|
+
* Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
23429
23544
|
*/
|
|
23430
23545
|
networks: outputs.GetZeroTrustDnsLocationEndpointsIpv6Network[];
|
|
23431
23546
|
}
|
|
23432
23547
|
export interface GetZeroTrustDnsLocationEndpointsIpv6Network {
|
|
23433
23548
|
/**
|
|
23434
|
-
*
|
|
23549
|
+
* Specify the IPv6 address or IPv6 CIDR.
|
|
23435
23550
|
*/
|
|
23436
23551
|
network: string;
|
|
23437
23552
|
}
|
|
23438
23553
|
export interface GetZeroTrustDnsLocationNetwork {
|
|
23439
23554
|
/**
|
|
23440
|
-
*
|
|
23555
|
+
* Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24.
|
|
23441
23556
|
*/
|
|
23442
23557
|
network: string;
|
|
23443
23558
|
}
|
|
23444
23559
|
export interface GetZeroTrustDnsLocationsResult {
|
|
23445
23560
|
/**
|
|
23446
|
-
*
|
|
23561
|
+
* Indicate whether this location is the default location.
|
|
23447
23562
|
*/
|
|
23448
23563
|
clientDefault: boolean;
|
|
23449
23564
|
createdAt: string;
|
|
23450
23565
|
/**
|
|
23451
|
-
*
|
|
23566
|
+
* Indicate the identifier of the pair of IPv4 addresses assigned to this location.
|
|
23452
23567
|
*/
|
|
23453
23568
|
dnsDestinationIpsId: string;
|
|
23454
23569
|
/**
|
|
23455
|
-
*
|
|
23570
|
+
* Specify the UUID of the IPv6 block brought to the gateway so that this location's IPv6 address is allocated from the Bring Your Own IPv6 (BYOIPv6) block rather than the standard Cloudflare IPv6 block.
|
|
23456
23571
|
*/
|
|
23457
23572
|
dnsDestinationIpv6BlockId: string;
|
|
23458
23573
|
/**
|
|
23459
|
-
*
|
|
23574
|
+
* Specify the DNS over HTTPS domain that receives DNS requests. Gateway automatically generates this value.
|
|
23460
23575
|
*/
|
|
23461
23576
|
dohSubdomain: string;
|
|
23462
23577
|
/**
|
|
23463
|
-
*
|
|
23578
|
+
* Indicate whether the location must resolve EDNS queries.
|
|
23464
23579
|
*/
|
|
23465
23580
|
ecsSupport: boolean;
|
|
23466
23581
|
/**
|
|
23467
|
-
*
|
|
23582
|
+
* Configure the destination endpoints for this location.
|
|
23468
23583
|
*/
|
|
23469
23584
|
endpoints: outputs.GetZeroTrustDnsLocationsResultEndpoints;
|
|
23470
23585
|
id: string;
|
|
23471
23586
|
/**
|
|
23472
|
-
*
|
|
23587
|
+
* Defines the automatically generated IPv6 destination IP assigned to this location. Gateway counts all DNS requests sent to this IP as requests under this location.
|
|
23473
23588
|
*/
|
|
23474
23589
|
ip: string;
|
|
23475
23590
|
/**
|
|
23476
|
-
*
|
|
23591
|
+
* Show the primary destination IPv4 address from the pair identified dns*destination*ips_id. This field read-only.
|
|
23477
23592
|
*/
|
|
23478
23593
|
ipv4Destination: string;
|
|
23479
23594
|
/**
|
|
23480
|
-
*
|
|
23595
|
+
* Show the backup destination IPv4 address from the pair identified dns*destination*ips_id. This field read-only.
|
|
23481
23596
|
*/
|
|
23482
23597
|
ipv4DestinationBackup: string;
|
|
23483
23598
|
/**
|
|
23484
|
-
*
|
|
23599
|
+
* Specify the location name.
|
|
23485
23600
|
*/
|
|
23486
23601
|
name: string;
|
|
23487
23602
|
/**
|
|
23488
|
-
*
|
|
23603
|
+
* Specify the list of network ranges from which requests at this location originate. The list takes effect only if it is non-empty and the IPv4 endpoint is enabled for this location.
|
|
23489
23604
|
*/
|
|
23490
23605
|
networks: outputs.GetZeroTrustDnsLocationsResultNetwork[];
|
|
23491
23606
|
updatedAt: string;
|
|
@@ -23498,171 +23613,171 @@ export interface GetZeroTrustDnsLocationsResultEndpoints {
|
|
|
23498
23613
|
}
|
|
23499
23614
|
export interface GetZeroTrustDnsLocationsResultEndpointsDoh {
|
|
23500
23615
|
/**
|
|
23501
|
-
*
|
|
23616
|
+
* Indicate whether the DOH endpoint is enabled for this location.
|
|
23502
23617
|
*/
|
|
23503
23618
|
enabled: boolean;
|
|
23504
23619
|
/**
|
|
23505
|
-
*
|
|
23620
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
23506
23621
|
*/
|
|
23507
23622
|
networks: outputs.GetZeroTrustDnsLocationsResultEndpointsDohNetwork[];
|
|
23508
23623
|
/**
|
|
23509
|
-
*
|
|
23624
|
+
* Specify whether the DOH endpoint requires user identity authentication.
|
|
23510
23625
|
*/
|
|
23511
23626
|
requireToken: boolean;
|
|
23512
23627
|
}
|
|
23513
23628
|
export interface GetZeroTrustDnsLocationsResultEndpointsDohNetwork {
|
|
23514
23629
|
/**
|
|
23515
|
-
*
|
|
23630
|
+
* Specify the IP address or IP CIDR.
|
|
23516
23631
|
*/
|
|
23517
23632
|
network: string;
|
|
23518
23633
|
}
|
|
23519
23634
|
export interface GetZeroTrustDnsLocationsResultEndpointsDot {
|
|
23520
23635
|
/**
|
|
23521
|
-
*
|
|
23636
|
+
* Indicate whether the DOT endpoint is enabled for this location.
|
|
23522
23637
|
*/
|
|
23523
23638
|
enabled: boolean;
|
|
23524
23639
|
/**
|
|
23525
|
-
*
|
|
23640
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
23526
23641
|
*/
|
|
23527
23642
|
networks: outputs.GetZeroTrustDnsLocationsResultEndpointsDotNetwork[];
|
|
23528
23643
|
}
|
|
23529
23644
|
export interface GetZeroTrustDnsLocationsResultEndpointsDotNetwork {
|
|
23530
23645
|
/**
|
|
23531
|
-
*
|
|
23646
|
+
* Specify the IP address or IP CIDR.
|
|
23532
23647
|
*/
|
|
23533
23648
|
network: string;
|
|
23534
23649
|
}
|
|
23535
23650
|
export interface GetZeroTrustDnsLocationsResultEndpointsIpv4 {
|
|
23536
23651
|
/**
|
|
23537
|
-
*
|
|
23652
|
+
* Indicate whether the IPv4 endpoint is enabled for this location.
|
|
23538
23653
|
*/
|
|
23539
23654
|
enabled: boolean;
|
|
23540
23655
|
}
|
|
23541
23656
|
export interface GetZeroTrustDnsLocationsResultEndpointsIpv6 {
|
|
23542
23657
|
/**
|
|
23543
|
-
*
|
|
23658
|
+
* Indicate whether the IPV6 endpoint is enabled for this location.
|
|
23544
23659
|
*/
|
|
23545
23660
|
enabled: boolean;
|
|
23546
23661
|
/**
|
|
23547
|
-
*
|
|
23662
|
+
* Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
23548
23663
|
*/
|
|
23549
23664
|
networks: outputs.GetZeroTrustDnsLocationsResultEndpointsIpv6Network[];
|
|
23550
23665
|
}
|
|
23551
23666
|
export interface GetZeroTrustDnsLocationsResultEndpointsIpv6Network {
|
|
23552
23667
|
/**
|
|
23553
|
-
*
|
|
23668
|
+
* Specify the IPv6 address or IPv6 CIDR.
|
|
23554
23669
|
*/
|
|
23555
23670
|
network: string;
|
|
23556
23671
|
}
|
|
23557
23672
|
export interface GetZeroTrustDnsLocationsResultNetwork {
|
|
23558
23673
|
/**
|
|
23559
|
-
*
|
|
23674
|
+
* Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24.
|
|
23560
23675
|
*/
|
|
23561
23676
|
network: string;
|
|
23562
23677
|
}
|
|
23563
23678
|
export interface GetZeroTrustGatewayAppTypesListResult {
|
|
23564
23679
|
/**
|
|
23565
|
-
*
|
|
23680
|
+
* Identify the type of this application. Multiple applications can share the same type. Refers to the `id` of a returned application type.
|
|
23566
23681
|
*/
|
|
23567
23682
|
applicationTypeId: number;
|
|
23568
23683
|
createdAt: string;
|
|
23569
23684
|
/**
|
|
23570
|
-
*
|
|
23685
|
+
* Provide a short summary of applications with this type.
|
|
23571
23686
|
*/
|
|
23572
23687
|
description: string;
|
|
23573
23688
|
/**
|
|
23574
|
-
*
|
|
23689
|
+
* Identify this application. Only one application per ID.
|
|
23575
23690
|
*/
|
|
23576
23691
|
id: number;
|
|
23577
23692
|
/**
|
|
23578
|
-
*
|
|
23693
|
+
* Specify the name of the application or application type.
|
|
23579
23694
|
*/
|
|
23580
23695
|
name: string;
|
|
23581
23696
|
}
|
|
23582
23697
|
export interface GetZeroTrustGatewayCategoriesListResult {
|
|
23583
23698
|
/**
|
|
23584
|
-
*
|
|
23699
|
+
* Indicate whether the category is in beta and subject to change.
|
|
23585
23700
|
*/
|
|
23586
23701
|
beta: boolean;
|
|
23587
23702
|
/**
|
|
23588
|
-
*
|
|
23703
|
+
* Specify which account types can create policies for this category. `blocked` Blocks unconditionally for all accounts. `removalPending` Allows removal from policies but disables addition. `noBlock` Prevents blocking.
|
|
23589
23704
|
* Available values: "free", "premium", "blocked", "removalPending", "noBlock".
|
|
23590
23705
|
*/
|
|
23591
23706
|
class: string;
|
|
23592
23707
|
/**
|
|
23593
|
-
*
|
|
23708
|
+
* Provide a short summary of domains in the category.
|
|
23594
23709
|
*/
|
|
23595
23710
|
description: string;
|
|
23596
23711
|
/**
|
|
23597
|
-
*
|
|
23712
|
+
* Identify this category. Only one category per ID.
|
|
23598
23713
|
*/
|
|
23599
23714
|
id: number;
|
|
23600
23715
|
/**
|
|
23601
|
-
*
|
|
23716
|
+
* Specify the category name.
|
|
23602
23717
|
*/
|
|
23603
23718
|
name: string;
|
|
23604
23719
|
/**
|
|
23605
|
-
*
|
|
23720
|
+
* Provide all subcategories for this category.
|
|
23606
23721
|
*/
|
|
23607
23722
|
subcategories: outputs.GetZeroTrustGatewayCategoriesListResultSubcategory[];
|
|
23608
23723
|
}
|
|
23609
23724
|
export interface GetZeroTrustGatewayCategoriesListResultSubcategory {
|
|
23610
23725
|
/**
|
|
23611
|
-
*
|
|
23726
|
+
* Indicate whether the category is in beta and subject to change.
|
|
23612
23727
|
*/
|
|
23613
23728
|
beta: boolean;
|
|
23614
23729
|
/**
|
|
23615
|
-
*
|
|
23730
|
+
* Specify which account types can create policies for this category. `blocked` Blocks unconditionally for all accounts. `removalPending` Allows removal from policies but disables addition. `noBlock` Prevents blocking.
|
|
23616
23731
|
* Available values: "free", "premium", "blocked", "removalPending", "noBlock".
|
|
23617
23732
|
*/
|
|
23618
23733
|
class: string;
|
|
23619
23734
|
/**
|
|
23620
|
-
*
|
|
23735
|
+
* Provide a short summary of domains in the category.
|
|
23621
23736
|
*/
|
|
23622
23737
|
description: string;
|
|
23623
23738
|
/**
|
|
23624
|
-
*
|
|
23739
|
+
* Identify this category. Only one category per ID.
|
|
23625
23740
|
*/
|
|
23626
23741
|
id: number;
|
|
23627
23742
|
/**
|
|
23628
|
-
*
|
|
23743
|
+
* Specify the category name.
|
|
23629
23744
|
*/
|
|
23630
23745
|
name: string;
|
|
23631
23746
|
}
|
|
23632
23747
|
export interface GetZeroTrustGatewayCertificatesResult {
|
|
23633
23748
|
/**
|
|
23634
|
-
*
|
|
23749
|
+
* Indicate the read-only deployment status of the certificate on Cloudflare's edge. Gateway TLS interception can use certificates in the 'available' (previously called 'active') state.
|
|
23635
23750
|
* Available values: "pending*deployment", "available", "pending*deletion", "inactive".
|
|
23636
23751
|
*/
|
|
23637
23752
|
bindingStatus: string;
|
|
23638
23753
|
/**
|
|
23639
|
-
*
|
|
23754
|
+
* Provide the CA certificate (read-only).
|
|
23640
23755
|
*/
|
|
23641
23756
|
certificate: string;
|
|
23642
23757
|
createdAt: string;
|
|
23643
23758
|
expiresOn: string;
|
|
23644
23759
|
/**
|
|
23645
|
-
*
|
|
23760
|
+
* Provide the SHA256 fingerprint of the certificate (read-only).
|
|
23646
23761
|
*/
|
|
23647
23762
|
fingerprint: string;
|
|
23648
23763
|
/**
|
|
23649
|
-
*
|
|
23764
|
+
* Identify the certificate with a UUID.
|
|
23650
23765
|
*/
|
|
23651
23766
|
id: string;
|
|
23652
23767
|
/**
|
|
23653
|
-
*
|
|
23768
|
+
* Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only).
|
|
23654
23769
|
*/
|
|
23655
23770
|
inUse: boolean;
|
|
23656
23771
|
/**
|
|
23657
|
-
*
|
|
23772
|
+
* Indicate the organization that issued the certificate (read-only).
|
|
23658
23773
|
*/
|
|
23659
23774
|
issuerOrg: string;
|
|
23660
23775
|
/**
|
|
23661
|
-
*
|
|
23776
|
+
* Provide the entire issuer field of the certificate (read-only).
|
|
23662
23777
|
*/
|
|
23663
23778
|
issuerRaw: string;
|
|
23664
23779
|
/**
|
|
23665
|
-
*
|
|
23780
|
+
* Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.
|
|
23666
23781
|
* Available values: "custom", "gatewayManaged".
|
|
23667
23782
|
*/
|
|
23668
23783
|
type: string;
|
|
@@ -23670,238 +23785,242 @@ export interface GetZeroTrustGatewayCertificatesResult {
|
|
|
23670
23785
|
uploadedOn: string;
|
|
23671
23786
|
}
|
|
23672
23787
|
export interface GetZeroTrustGatewayLoggingSettingsByRuleType {
|
|
23788
|
+
/**
|
|
23789
|
+
* Configure logging settings for DNS firewall.
|
|
23790
|
+
*/
|
|
23673
23791
|
dns: outputs.GetZeroTrustGatewayLoggingSettingsByRuleTypeDns;
|
|
23792
|
+
/**
|
|
23793
|
+
* Configure logging settings for HTTP/HTTPS firewall.
|
|
23794
|
+
*/
|
|
23674
23795
|
http: outputs.GetZeroTrustGatewayLoggingSettingsByRuleTypeHttp;
|
|
23796
|
+
/**
|
|
23797
|
+
* Configure logging settings for Network firewall.
|
|
23798
|
+
*/
|
|
23675
23799
|
l4: outputs.GetZeroTrustGatewayLoggingSettingsByRuleTypeL4;
|
|
23676
23800
|
}
|
|
23677
23801
|
export interface GetZeroTrustGatewayLoggingSettingsByRuleTypeDns {
|
|
23678
23802
|
/**
|
|
23679
|
-
*
|
|
23803
|
+
* Specify whether to log all requests to this service.
|
|
23680
23804
|
*/
|
|
23681
23805
|
logAll: boolean;
|
|
23682
23806
|
/**
|
|
23683
|
-
*
|
|
23807
|
+
* Specify whether to log only blocking requests to this service.
|
|
23684
23808
|
*/
|
|
23685
23809
|
logBlocks: boolean;
|
|
23686
23810
|
}
|
|
23687
23811
|
export interface GetZeroTrustGatewayLoggingSettingsByRuleTypeHttp {
|
|
23688
23812
|
/**
|
|
23689
|
-
*
|
|
23813
|
+
* Specify whether to log all requests to this service.
|
|
23690
23814
|
*/
|
|
23691
23815
|
logAll: boolean;
|
|
23692
23816
|
/**
|
|
23693
|
-
*
|
|
23817
|
+
* Specify whether to log only blocking requests to this service.
|
|
23694
23818
|
*/
|
|
23695
23819
|
logBlocks: boolean;
|
|
23696
23820
|
}
|
|
23697
23821
|
export interface GetZeroTrustGatewayLoggingSettingsByRuleTypeL4 {
|
|
23698
23822
|
/**
|
|
23699
|
-
*
|
|
23823
|
+
* Specify whether to log all requests to this service.
|
|
23700
23824
|
*/
|
|
23701
23825
|
logAll: boolean;
|
|
23702
23826
|
/**
|
|
23703
|
-
*
|
|
23827
|
+
* Specify whether to log only blocking requests to this service.
|
|
23704
23828
|
*/
|
|
23705
23829
|
logBlocks: boolean;
|
|
23706
23830
|
}
|
|
23707
23831
|
export interface GetZeroTrustGatewayPoliciesResult {
|
|
23708
23832
|
/**
|
|
23709
|
-
*
|
|
23833
|
+
* Specify the action to perform when the associated traffic, identity, and device posture expressions either absent or evaluate to `true`.
|
|
23710
23834
|
* Available values: "on", "off", "allow", "block", "scan", "noscan", "safesearch", "ytrestricted", "isolate", "noisolate", "override", "l4Override", "egress", "resolve", "quarantine", "redirect".
|
|
23711
23835
|
*/
|
|
23712
23836
|
action: string;
|
|
23713
23837
|
createdAt: string;
|
|
23714
23838
|
/**
|
|
23715
|
-
*
|
|
23839
|
+
* Indicate the date of deletion, if any.
|
|
23716
23840
|
*/
|
|
23717
23841
|
deletedAt: string;
|
|
23718
23842
|
/**
|
|
23719
|
-
*
|
|
23843
|
+
* Specify the rule description.
|
|
23720
23844
|
*/
|
|
23721
23845
|
description: string;
|
|
23722
23846
|
devicePosture: string;
|
|
23723
23847
|
/**
|
|
23724
|
-
*
|
|
23848
|
+
* Specify whether the rule is enabled.
|
|
23725
23849
|
*/
|
|
23726
23850
|
enabled: boolean;
|
|
23727
23851
|
/**
|
|
23728
|
-
*
|
|
23729
|
-
* precedence over the policy's `schedule` configuration, if any.
|
|
23852
|
+
* Defines the expiration time stamp and default duration of a DNS policy. Takes precedence over the policy's `schedule` configuration, if any. This does not apply to HTTP or network policies. Settable only for `dns` rules.
|
|
23730
23853
|
*/
|
|
23731
23854
|
expiration: outputs.GetZeroTrustGatewayPoliciesResultExpiration;
|
|
23732
23855
|
/**
|
|
23733
|
-
*
|
|
23856
|
+
* Specify the protocol or layer to evaluate the traffic, identity, and device posture expressions.
|
|
23734
23857
|
*/
|
|
23735
23858
|
filters: string[];
|
|
23736
23859
|
/**
|
|
23737
|
-
*
|
|
23860
|
+
* Identify the API resource with a UUID.
|
|
23738
23861
|
*/
|
|
23739
23862
|
id: string;
|
|
23740
23863
|
identity: string;
|
|
23741
23864
|
/**
|
|
23742
|
-
*
|
|
23865
|
+
* Specify the rule name.
|
|
23743
23866
|
*/
|
|
23744
23867
|
name: string;
|
|
23745
|
-
/**
|
|
23746
|
-
* The rule cannot be shared via the Orgs API.
|
|
23747
|
-
*/
|
|
23748
|
-
notSharable: boolean;
|
|
23749
23868
|
precedence: number;
|
|
23750
23869
|
/**
|
|
23751
|
-
*
|
|
23870
|
+
* Indicate that this rule is shared via the Orgs API and read only.
|
|
23752
23871
|
*/
|
|
23753
23872
|
readOnly: boolean;
|
|
23754
|
-
/**
|
|
23755
|
-
* Additional settings that modify the rule's action.
|
|
23756
|
-
*/
|
|
23757
23873
|
ruleSettings: outputs.GetZeroTrustGatewayPoliciesResultRuleSettings;
|
|
23758
23874
|
/**
|
|
23759
|
-
*
|
|
23875
|
+
* Defines the schedule for activating DNS policies. Settable only for `dns` and `dnsResolver` rules.
|
|
23760
23876
|
*/
|
|
23761
23877
|
schedule: outputs.GetZeroTrustGatewayPoliciesResultSchedule;
|
|
23762
23878
|
/**
|
|
23763
|
-
*
|
|
23879
|
+
* Indicate that this rule is sharable via the Orgs API.
|
|
23880
|
+
*/
|
|
23881
|
+
sharable: boolean;
|
|
23882
|
+
/**
|
|
23883
|
+
* Provide the account tag of the account that created the rule.
|
|
23764
23884
|
*/
|
|
23765
23885
|
sourceAccount: string;
|
|
23766
23886
|
traffic: string;
|
|
23767
23887
|
updatedAt: string;
|
|
23768
23888
|
/**
|
|
23769
|
-
* version number of the rule.
|
|
23889
|
+
* Indicate the version number of the rule(read-only).
|
|
23770
23890
|
*/
|
|
23771
23891
|
version: number;
|
|
23772
23892
|
/**
|
|
23773
|
-
*
|
|
23893
|
+
* Indicate a warning for a misconfigured rule, if any.
|
|
23774
23894
|
*/
|
|
23775
23895
|
warningStatus: string;
|
|
23776
23896
|
}
|
|
23777
23897
|
export interface GetZeroTrustGatewayPoliciesResultExpiration {
|
|
23778
23898
|
/**
|
|
23779
|
-
*
|
|
23899
|
+
* Defines the default duration a policy active in minutes. Must set in order to use the `resetExpiration` endpoint on this rule.
|
|
23780
23900
|
*/
|
|
23781
23901
|
duration: number;
|
|
23782
23902
|
/**
|
|
23783
|
-
*
|
|
23903
|
+
* Indicates whether the policy is expired.
|
|
23784
23904
|
*/
|
|
23785
23905
|
expired: boolean;
|
|
23786
23906
|
/**
|
|
23787
|
-
*
|
|
23788
|
-
* applied.
|
|
23907
|
+
* Show the timestamp when the policy expires and stops applying. The value must follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets but converts them to the equivalent UTC+00:00 value and returns timestamps with a trailing Z. Expiration policies ignore client timezones and expire globally at the specified expiresAt time.
|
|
23789
23908
|
*/
|
|
23790
23909
|
expiresAt: string;
|
|
23791
23910
|
}
|
|
23792
23911
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettings {
|
|
23793
23912
|
/**
|
|
23794
|
-
* Add custom headers to allowed requests
|
|
23913
|
+
* Add custom headers to allowed requests as key-value pairs. Use header names as keys that map to arrays of header values. Settable only for `http` rules with the action set to `allow`.
|
|
23795
23914
|
*/
|
|
23796
23915
|
addHeaders: {
|
|
23797
23916
|
[key: string]: string[];
|
|
23798
23917
|
};
|
|
23799
23918
|
/**
|
|
23800
|
-
* Set
|
|
23919
|
+
* Set to enable MSP children to bypass this rule. Only parent MSP accounts can set this. this rule. Settable for all types of rules.
|
|
23801
23920
|
*/
|
|
23802
23921
|
allowChildBypass: boolean;
|
|
23803
23922
|
/**
|
|
23804
|
-
*
|
|
23923
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with `auditSsh` action.
|
|
23805
23924
|
*/
|
|
23806
23925
|
auditSsh: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsAuditSsh;
|
|
23807
23926
|
/**
|
|
23808
|
-
* Configure
|
|
23927
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the action set to `isolate`.
|
|
23809
23928
|
*/
|
|
23810
23929
|
bisoAdminControls: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsBisoAdminControls;
|
|
23811
23930
|
/**
|
|
23812
|
-
*
|
|
23931
|
+
* Configure custom block page settings. If missing or null, use the account settings. Settable only for `http` rules with the action set to `block`.
|
|
23813
23932
|
*/
|
|
23814
23933
|
blockPage: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsBlockPage;
|
|
23815
23934
|
/**
|
|
23816
|
-
* Enable the custom block page.
|
|
23935
|
+
* Enable the custom block page. Settable only for `dns` rules with action `block`.
|
|
23817
23936
|
*/
|
|
23818
23937
|
blockPageEnabled: boolean;
|
|
23819
23938
|
/**
|
|
23820
|
-
*
|
|
23939
|
+
* Explain why the rule blocks the request. The custom block page shows this text (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action set to `block`.
|
|
23821
23940
|
*/
|
|
23822
23941
|
blockReason: string;
|
|
23823
23942
|
/**
|
|
23824
|
-
* Set
|
|
23943
|
+
* Set to enable MSP accounts to bypass their parent's rules. Only MSP child accounts can set this. Settable for all types of rules.
|
|
23825
23944
|
*/
|
|
23826
23945
|
bypassParentRule: boolean;
|
|
23827
23946
|
/**
|
|
23828
|
-
* Configure
|
|
23947
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with the action set to `allow`.
|
|
23829
23948
|
*/
|
|
23830
23949
|
checkSession: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsCheckSession;
|
|
23831
23950
|
/**
|
|
23832
|
-
*
|
|
23951
|
+
* Configure custom resolvers to route queries that match the resolver policy. Unused with 'resolve*dns*through*cloudflare' or 'resolve*dns*internally' settings. DNS queries get routed to the address closest to their origin. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
23833
23952
|
*/
|
|
23834
23953
|
dnsResolvers: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsDnsResolvers;
|
|
23835
23954
|
/**
|
|
23836
|
-
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.
|
|
23955
|
+
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs. Settable only for `egress` rules.
|
|
23837
23956
|
*/
|
|
23838
23957
|
egress: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsEgress;
|
|
23839
23958
|
/**
|
|
23840
|
-
*
|
|
23959
|
+
* Ignore category matches at CNAME domains in a response. When off, evaluate categories in this rule against all CNAME domain categories in the response. Settable only for `dns` and `dnsResolver` rules.
|
|
23841
23960
|
*/
|
|
23842
23961
|
ignoreCnameCategoryMatches: boolean;
|
|
23843
23962
|
/**
|
|
23844
|
-
*
|
|
23963
|
+
* Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE]. Settable only for `dns` rules.
|
|
23845
23964
|
*/
|
|
23846
23965
|
insecureDisableDnssecValidation: boolean;
|
|
23847
23966
|
/**
|
|
23848
|
-
*
|
|
23967
|
+
* Enable IPs in DNS resolver category blocks. The system blocks only domain name categories unless you enable this setting. Settable only for `dns` and `dnsResolver` rules.
|
|
23849
23968
|
*/
|
|
23850
23969
|
ipCategories: boolean;
|
|
23851
23970
|
/**
|
|
23852
|
-
*
|
|
23971
|
+
* Indicates whether to include IPs in DNS resolver indicator feed blocks. Default, indicator feeds block only domain names. Settable only for `dns` and `dnsResolver` rules.
|
|
23853
23972
|
*/
|
|
23854
23973
|
ipIndicatorFeeds: boolean;
|
|
23855
23974
|
/**
|
|
23856
|
-
* Send matching traffic to the supplied destination IP address
|
|
23975
|
+
* Send matching traffic to the supplied destination IP address and port. Settable only for `l4` rules with the action set to `l4Override`.
|
|
23857
23976
|
*/
|
|
23858
23977
|
l4override: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsL4override;
|
|
23859
23978
|
/**
|
|
23860
|
-
* Configure a notification to display on the user's device when this rule
|
|
23979
|
+
* Configure a notification to display on the user's device when this rule matched. Settable for all types of rules with the action set to `block`.
|
|
23861
23980
|
*/
|
|
23862
23981
|
notificationSettings: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsNotificationSettings;
|
|
23863
23982
|
/**
|
|
23864
|
-
*
|
|
23983
|
+
* Defines a hostname for override, for the matching DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
23865
23984
|
*/
|
|
23866
23985
|
overrideHost: string;
|
|
23867
23986
|
/**
|
|
23868
|
-
*
|
|
23987
|
+
* Defines a an IP or set of IPs for overriding matched DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
23869
23988
|
*/
|
|
23870
23989
|
overrideIps: string[];
|
|
23871
23990
|
/**
|
|
23872
|
-
* Configure DLP payload logging.
|
|
23991
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
23873
23992
|
*/
|
|
23874
23993
|
payloadLog: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsPayloadLog;
|
|
23875
23994
|
/**
|
|
23876
|
-
*
|
|
23995
|
+
* Configure settings that apply to quarantine rules. Settable only for `http` rules.
|
|
23877
23996
|
*/
|
|
23878
23997
|
quarantine: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsQuarantine;
|
|
23879
23998
|
/**
|
|
23880
|
-
*
|
|
23999
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action set to `redirect`.
|
|
23881
24000
|
*/
|
|
23882
24001
|
redirect: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsRedirect;
|
|
23883
24002
|
/**
|
|
23884
|
-
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input.
|
|
24003
|
+
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input. Not used when 'dns*resolvers' is specified or 'resolve*dns*through*cloudflare' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
23885
24004
|
*/
|
|
23886
24005
|
resolveDnsInternally: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsResolveDnsInternally;
|
|
23887
24006
|
/**
|
|
23888
|
-
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot
|
|
24007
|
+
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot set when 'dns*resolvers' specified or 'resolve*dns_internally' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
23889
24008
|
*/
|
|
23890
24009
|
resolveDnsThroughCloudflare: boolean;
|
|
23891
24010
|
/**
|
|
23892
|
-
* Configure behavior when an upstream
|
|
24011
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error occurs. Settable only for `http` rules with the action set to `allow`.
|
|
23893
24012
|
*/
|
|
23894
24013
|
untrustedCert: outputs.GetZeroTrustGatewayPoliciesResultRuleSettingsUntrustedCert;
|
|
23895
24014
|
}
|
|
23896
24015
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsAuditSsh {
|
|
23897
24016
|
/**
|
|
23898
|
-
* Enable
|
|
24017
|
+
* Enable SSH command logging.
|
|
23899
24018
|
*/
|
|
23900
24019
|
commandLogging: boolean;
|
|
23901
24020
|
}
|
|
23902
24021
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsBisoAdminControls {
|
|
23903
24022
|
/**
|
|
23904
|
-
* Configure
|
|
24023
|
+
* Configure copy behavior. If set to remote*only, users cannot copy isolated content from the remote browser to the local clipboard. If this field is absent, copying remains enabled. Applies only when version == "v2".
|
|
23905
24024
|
* Available values: "enabled", "disabled", "remote*only".
|
|
23906
24025
|
*/
|
|
23907
24026
|
copy: string;
|
|
@@ -23918,7 +24037,7 @@ export interface GetZeroTrustGatewayPoliciesResultRuleSettingsBisoAdminControls
|
|
|
23918
24037
|
*/
|
|
23919
24038
|
dk: boolean;
|
|
23920
24039
|
/**
|
|
23921
|
-
* Configure
|
|
24040
|
+
* Configure download behavior. When set to remote*only, users can view downloads but cannot save them. Applies only when version == "v2".
|
|
23922
24041
|
* Available values: "enabled", "disabled", "remote*only".
|
|
23923
24042
|
*/
|
|
23924
24043
|
download: string;
|
|
@@ -23931,45 +24050,48 @@ export interface GetZeroTrustGatewayPoliciesResultRuleSettingsBisoAdminControls
|
|
|
23931
24050
|
*/
|
|
23932
24051
|
du: boolean;
|
|
23933
24052
|
/**
|
|
23934
|
-
* Configure
|
|
24053
|
+
* Configure keyboard usage behavior. If this field is absent, keyboard usage remains enabled. Applies only when version == "v2".
|
|
23935
24054
|
* Available values: "enabled", "disabled".
|
|
23936
24055
|
*/
|
|
23937
24056
|
keyboard: string;
|
|
23938
24057
|
/**
|
|
23939
|
-
* Configure
|
|
24058
|
+
* Configure paste behavior. If set to remote*only, users cannot paste content from the local clipboard into isolated pages. If this field is absent, pasting remains enabled. Applies only when version == "v2".
|
|
23940
24059
|
* Available values: "enabled", "disabled", "remote*only".
|
|
23941
24060
|
*/
|
|
23942
24061
|
paste: string;
|
|
23943
24062
|
/**
|
|
23944
|
-
* Configure
|
|
24063
|
+
* Configure print behavior. Default, Printing is enabled. Applies only when version == "v2".
|
|
23945
24064
|
* Available values: "enabled", "disabled".
|
|
23946
24065
|
*/
|
|
23947
24066
|
printing: string;
|
|
23948
24067
|
/**
|
|
23949
|
-
* Configure
|
|
24068
|
+
* Configure upload behavior. If this field is absent, uploading remains enabled. Applies only when version == "v2".
|
|
23950
24069
|
* Available values: "enabled", "disabled".
|
|
23951
24070
|
*/
|
|
23952
24071
|
upload: string;
|
|
23953
24072
|
/**
|
|
23954
|
-
*
|
|
24073
|
+
* Indicate which version of the browser isolation controls should apply.
|
|
23955
24074
|
* Available values: "v1", "v2".
|
|
23956
24075
|
*/
|
|
23957
24076
|
version: string;
|
|
23958
24077
|
}
|
|
23959
24078
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsBlockPage {
|
|
23960
24079
|
/**
|
|
23961
|
-
*
|
|
24080
|
+
* Specify whether to pass the context information as query parameters.
|
|
23962
24081
|
*/
|
|
23963
24082
|
includeContext: boolean;
|
|
23964
24083
|
/**
|
|
23965
|
-
* URI to which the user
|
|
24084
|
+
* Specify the URI to which the user is redirected.
|
|
23966
24085
|
*/
|
|
23967
24086
|
targetUri: string;
|
|
23968
24087
|
}
|
|
23969
24088
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsCheckSession {
|
|
24089
|
+
/**
|
|
24090
|
+
* Sets the required session freshness threshold. The API returns a normalized version of this value.
|
|
24091
|
+
*/
|
|
23970
24092
|
duration: string;
|
|
23971
24093
|
/**
|
|
23972
|
-
*
|
|
24094
|
+
* Enable session enforcement.
|
|
23973
24095
|
*/
|
|
23974
24096
|
enforce: boolean;
|
|
23975
24097
|
}
|
|
@@ -23979,71 +24101,71 @@ export interface GetZeroTrustGatewayPoliciesResultRuleSettingsDnsResolvers {
|
|
|
23979
24101
|
}
|
|
23980
24102
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsDnsResolversIpv4 {
|
|
23981
24103
|
/**
|
|
23982
|
-
* IPv4 address of upstream resolver.
|
|
24104
|
+
* Specify the IPv4 address of the upstream resolver.
|
|
23983
24105
|
*/
|
|
23984
24106
|
ip: string;
|
|
23985
24107
|
/**
|
|
23986
|
-
*
|
|
24108
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
23987
24109
|
*/
|
|
23988
24110
|
port: number;
|
|
23989
24111
|
/**
|
|
23990
|
-
*
|
|
24112
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
23991
24113
|
*/
|
|
23992
24114
|
routeThroughPrivateNetwork: boolean;
|
|
23993
24115
|
/**
|
|
23994
|
-
*
|
|
24116
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
23995
24117
|
*/
|
|
23996
24118
|
vnetId: string;
|
|
23997
24119
|
}
|
|
23998
24120
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsDnsResolversIpv6 {
|
|
23999
24121
|
/**
|
|
24000
|
-
* IPv6 address of upstream resolver.
|
|
24122
|
+
* Specify the IPv6 address of the upstream resolver.
|
|
24001
24123
|
*/
|
|
24002
24124
|
ip: string;
|
|
24003
24125
|
/**
|
|
24004
|
-
*
|
|
24126
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
24005
24127
|
*/
|
|
24006
24128
|
port: number;
|
|
24007
24129
|
/**
|
|
24008
|
-
*
|
|
24130
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
24009
24131
|
*/
|
|
24010
24132
|
routeThroughPrivateNetwork: boolean;
|
|
24011
24133
|
/**
|
|
24012
|
-
*
|
|
24134
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
24013
24135
|
*/
|
|
24014
24136
|
vnetId: string;
|
|
24015
24137
|
}
|
|
24016
24138
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsEgress {
|
|
24017
24139
|
/**
|
|
24018
|
-
*
|
|
24140
|
+
* Specify the IPv4 address to use for egress.
|
|
24019
24141
|
*/
|
|
24020
24142
|
ipv4: string;
|
|
24021
24143
|
/**
|
|
24022
|
-
*
|
|
24144
|
+
* Specify the fallback IPv4 address to use for egress when the primary IPv4 fails. Set '0.0.0.0' to indicate local egress via WARP IPs.
|
|
24023
24145
|
*/
|
|
24024
24146
|
ipv4Fallback: string;
|
|
24025
24147
|
/**
|
|
24026
|
-
*
|
|
24148
|
+
* Specify the IPv6 range to use for egress.
|
|
24027
24149
|
*/
|
|
24028
24150
|
ipv6: string;
|
|
24029
24151
|
}
|
|
24030
24152
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsL4override {
|
|
24031
24153
|
/**
|
|
24032
|
-
* IPv4 or IPv6 address.
|
|
24154
|
+
* Defines the IPv4 or IPv6 address.
|
|
24033
24155
|
*/
|
|
24034
24156
|
ip: string;
|
|
24035
24157
|
/**
|
|
24036
|
-
*
|
|
24158
|
+
* Defines a port number to use for TCP/UDP overrides.
|
|
24037
24159
|
*/
|
|
24038
24160
|
port: number;
|
|
24039
24161
|
}
|
|
24040
24162
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsNotificationSettings {
|
|
24041
24163
|
/**
|
|
24042
|
-
*
|
|
24164
|
+
* Enable notification.
|
|
24043
24165
|
*/
|
|
24044
24166
|
enabled: boolean;
|
|
24045
24167
|
/**
|
|
24046
|
-
*
|
|
24168
|
+
* Indicates whether to pass the context information as query parameters.
|
|
24047
24169
|
*/
|
|
24048
24170
|
includeContext: boolean;
|
|
24049
24171
|
/**
|
|
@@ -24051,216 +24173,194 @@ export interface GetZeroTrustGatewayPoliciesResultRuleSettingsNotificationSettin
|
|
|
24051
24173
|
*/
|
|
24052
24174
|
msg: string;
|
|
24053
24175
|
/**
|
|
24054
|
-
*
|
|
24176
|
+
* Defines an optional URL to direct users to additional information. If unset, the notification opens a block page.
|
|
24055
24177
|
*/
|
|
24056
24178
|
supportUrl: string;
|
|
24057
24179
|
}
|
|
24058
24180
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsPayloadLog {
|
|
24059
24181
|
/**
|
|
24060
|
-
*
|
|
24182
|
+
* Enable DLP payload logging for this rule.
|
|
24061
24183
|
*/
|
|
24062
24184
|
enabled: boolean;
|
|
24063
24185
|
}
|
|
24064
24186
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsQuarantine {
|
|
24065
24187
|
/**
|
|
24066
|
-
*
|
|
24188
|
+
* Specify the types of files to sandbox.
|
|
24067
24189
|
*/
|
|
24068
24190
|
fileTypes: string[];
|
|
24069
24191
|
}
|
|
24070
24192
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsRedirect {
|
|
24071
24193
|
/**
|
|
24072
|
-
*
|
|
24194
|
+
* Specify whether to pass the context information as query parameters.
|
|
24073
24195
|
*/
|
|
24074
24196
|
includeContext: boolean;
|
|
24075
24197
|
/**
|
|
24076
|
-
*
|
|
24198
|
+
* Specify whether to append the path and query parameters from the original request to target_uri.
|
|
24077
24199
|
*/
|
|
24078
24200
|
preservePathAndQuery: boolean;
|
|
24079
24201
|
/**
|
|
24080
|
-
* URI to which the user
|
|
24202
|
+
* Specify the URI to which the user is redirected.
|
|
24081
24203
|
*/
|
|
24082
24204
|
targetUri: string;
|
|
24083
24205
|
}
|
|
24084
24206
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsResolveDnsInternally {
|
|
24085
24207
|
/**
|
|
24086
|
-
*
|
|
24208
|
+
* Specify the fallback behavior to apply when the internal DNS response code differs from 'NOERROR' or when the response data contains only CNAME records for 'A' or 'AAAA' queries.
|
|
24087
24209
|
* Available values: "none", "publicDns".
|
|
24088
24210
|
*/
|
|
24089
24211
|
fallback: string;
|
|
24090
24212
|
/**
|
|
24091
|
-
*
|
|
24213
|
+
* Specify the internal DNS view identifier to pass to the internal DNS service.
|
|
24092
24214
|
*/
|
|
24093
24215
|
viewId: string;
|
|
24094
24216
|
}
|
|
24095
24217
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsUntrustedCert {
|
|
24096
24218
|
/**
|
|
24097
|
-
*
|
|
24219
|
+
* Defines the action performed when an untrusted certificate seen. The default action an error with HTTP code 526.
|
|
24098
24220
|
* Available values: "passThrough", "block", "error".
|
|
24099
24221
|
*/
|
|
24100
24222
|
action: string;
|
|
24101
24223
|
}
|
|
24102
24224
|
export interface GetZeroTrustGatewayPoliciesResultSchedule {
|
|
24103
|
-
/**
|
|
24104
|
-
* The time intervals when the rule will be active on Fridays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Fridays.
|
|
24105
|
-
*/
|
|
24106
24225
|
fri: string;
|
|
24107
|
-
/**
|
|
24108
|
-
* The time intervals when the rule will be active on Mondays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Mondays.
|
|
24109
|
-
*/
|
|
24110
24226
|
mon: string;
|
|
24111
|
-
/**
|
|
24112
|
-
* The time intervals when the rule will be active on Saturdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Saturdays.
|
|
24113
|
-
*/
|
|
24114
24227
|
sat: string;
|
|
24115
|
-
/**
|
|
24116
|
-
* The time intervals when the rule will be active on Sundays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Sundays.
|
|
24117
|
-
*/
|
|
24118
24228
|
sun: string;
|
|
24119
|
-
/**
|
|
24120
|
-
* The time intervals when the rule will be active on Thursdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Thursdays.
|
|
24121
|
-
*/
|
|
24122
24229
|
thu: string;
|
|
24123
24230
|
/**
|
|
24124
|
-
*
|
|
24231
|
+
* Specify the time zone for rule evaluation. When a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway always uses the current time for that time zone. When this parameter is omitted, Gateway uses the time zone determined from the user's IP address. Colo time zone is used when the user's IP address does not resolve to a location.
|
|
24125
24232
|
*/
|
|
24126
24233
|
timeZone: string;
|
|
24127
|
-
/**
|
|
24128
|
-
* The time intervals when the rule will be active on Tuesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Tuesdays.
|
|
24129
|
-
*/
|
|
24130
24234
|
tue: string;
|
|
24131
|
-
/**
|
|
24132
|
-
* The time intervals when the rule will be active on Wednesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Wednesdays.
|
|
24133
|
-
*/
|
|
24134
24235
|
wed: string;
|
|
24135
24236
|
}
|
|
24136
24237
|
export interface GetZeroTrustGatewayPolicyExpiration {
|
|
24137
24238
|
/**
|
|
24138
|
-
*
|
|
24239
|
+
* Defines the default duration a policy active in minutes. Must set in order to use the `resetExpiration` endpoint on this rule.
|
|
24139
24240
|
*/
|
|
24140
24241
|
duration: number;
|
|
24141
24242
|
/**
|
|
24142
|
-
*
|
|
24243
|
+
* Indicates whether the policy is expired.
|
|
24143
24244
|
*/
|
|
24144
24245
|
expired: boolean;
|
|
24145
24246
|
/**
|
|
24146
|
-
*
|
|
24147
|
-
* applied.
|
|
24247
|
+
* Show the timestamp when the policy expires and stops applying. The value must follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets but converts them to the equivalent UTC+00:00 value and returns timestamps with a trailing Z. Expiration policies ignore client timezones and expire globally at the specified expiresAt time.
|
|
24148
24248
|
*/
|
|
24149
24249
|
expiresAt: string;
|
|
24150
24250
|
}
|
|
24151
24251
|
export interface GetZeroTrustGatewayPolicyRuleSettings {
|
|
24152
24252
|
/**
|
|
24153
|
-
* Add custom headers to allowed requests
|
|
24253
|
+
* Add custom headers to allowed requests as key-value pairs. Use header names as keys that map to arrays of header values. Settable only for `http` rules with the action set to `allow`.
|
|
24154
24254
|
*/
|
|
24155
24255
|
addHeaders: {
|
|
24156
24256
|
[key: string]: string[];
|
|
24157
24257
|
};
|
|
24158
24258
|
/**
|
|
24159
|
-
* Set
|
|
24259
|
+
* Set to enable MSP children to bypass this rule. Only parent MSP accounts can set this. this rule. Settable for all types of rules.
|
|
24160
24260
|
*/
|
|
24161
24261
|
allowChildBypass: boolean;
|
|
24162
24262
|
/**
|
|
24163
|
-
*
|
|
24263
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with `auditSsh` action.
|
|
24164
24264
|
*/
|
|
24165
24265
|
auditSsh: outputs.GetZeroTrustGatewayPolicyRuleSettingsAuditSsh;
|
|
24166
24266
|
/**
|
|
24167
|
-
* Configure
|
|
24267
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the action set to `isolate`.
|
|
24168
24268
|
*/
|
|
24169
24269
|
bisoAdminControls: outputs.GetZeroTrustGatewayPolicyRuleSettingsBisoAdminControls;
|
|
24170
24270
|
/**
|
|
24171
|
-
*
|
|
24271
|
+
* Configure custom block page settings. If missing or null, use the account settings. Settable only for `http` rules with the action set to `block`.
|
|
24172
24272
|
*/
|
|
24173
24273
|
blockPage: outputs.GetZeroTrustGatewayPolicyRuleSettingsBlockPage;
|
|
24174
24274
|
/**
|
|
24175
|
-
* Enable the custom block page.
|
|
24275
|
+
* Enable the custom block page. Settable only for `dns` rules with action `block`.
|
|
24176
24276
|
*/
|
|
24177
24277
|
blockPageEnabled: boolean;
|
|
24178
24278
|
/**
|
|
24179
|
-
*
|
|
24279
|
+
* Explain why the rule blocks the request. The custom block page shows this text (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action set to `block`.
|
|
24180
24280
|
*/
|
|
24181
24281
|
blockReason: string;
|
|
24182
24282
|
/**
|
|
24183
|
-
* Set
|
|
24283
|
+
* Set to enable MSP accounts to bypass their parent's rules. Only MSP child accounts can set this. Settable for all types of rules.
|
|
24184
24284
|
*/
|
|
24185
24285
|
bypassParentRule: boolean;
|
|
24186
24286
|
/**
|
|
24187
|
-
* Configure
|
|
24287
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with the action set to `allow`.
|
|
24188
24288
|
*/
|
|
24189
24289
|
checkSession: outputs.GetZeroTrustGatewayPolicyRuleSettingsCheckSession;
|
|
24190
24290
|
/**
|
|
24191
|
-
*
|
|
24291
|
+
* Configure custom resolvers to route queries that match the resolver policy. Unused with 'resolve*dns*through*cloudflare' or 'resolve*dns*internally' settings. DNS queries get routed to the address closest to their origin. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
24192
24292
|
*/
|
|
24193
24293
|
dnsResolvers: outputs.GetZeroTrustGatewayPolicyRuleSettingsDnsResolvers;
|
|
24194
24294
|
/**
|
|
24195
|
-
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.
|
|
24295
|
+
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs. Settable only for `egress` rules.
|
|
24196
24296
|
*/
|
|
24197
24297
|
egress: outputs.GetZeroTrustGatewayPolicyRuleSettingsEgress;
|
|
24198
24298
|
/**
|
|
24199
|
-
*
|
|
24299
|
+
* Ignore category matches at CNAME domains in a response. When off, evaluate categories in this rule against all CNAME domain categories in the response. Settable only for `dns` and `dnsResolver` rules.
|
|
24200
24300
|
*/
|
|
24201
24301
|
ignoreCnameCategoryMatches: boolean;
|
|
24202
24302
|
/**
|
|
24203
|
-
*
|
|
24303
|
+
* Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE]. Settable only for `dns` rules.
|
|
24204
24304
|
*/
|
|
24205
24305
|
insecureDisableDnssecValidation: boolean;
|
|
24206
24306
|
/**
|
|
24207
|
-
*
|
|
24307
|
+
* Enable IPs in DNS resolver category blocks. The system blocks only domain name categories unless you enable this setting. Settable only for `dns` and `dnsResolver` rules.
|
|
24208
24308
|
*/
|
|
24209
24309
|
ipCategories: boolean;
|
|
24210
24310
|
/**
|
|
24211
|
-
*
|
|
24311
|
+
* Indicates whether to include IPs in DNS resolver indicator feed blocks. Default, indicator feeds block only domain names. Settable only for `dns` and `dnsResolver` rules.
|
|
24212
24312
|
*/
|
|
24213
24313
|
ipIndicatorFeeds: boolean;
|
|
24214
24314
|
/**
|
|
24215
|
-
* Send matching traffic to the supplied destination IP address
|
|
24315
|
+
* Send matching traffic to the supplied destination IP address and port. Settable only for `l4` rules with the action set to `l4Override`.
|
|
24216
24316
|
*/
|
|
24217
24317
|
l4override: outputs.GetZeroTrustGatewayPolicyRuleSettingsL4override;
|
|
24218
24318
|
/**
|
|
24219
|
-
* Configure a notification to display on the user's device when this rule
|
|
24319
|
+
* Configure a notification to display on the user's device when this rule matched. Settable for all types of rules with the action set to `block`.
|
|
24220
24320
|
*/
|
|
24221
24321
|
notificationSettings: outputs.GetZeroTrustGatewayPolicyRuleSettingsNotificationSettings;
|
|
24222
24322
|
/**
|
|
24223
|
-
*
|
|
24323
|
+
* Defines a hostname for override, for the matching DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
24224
24324
|
*/
|
|
24225
24325
|
overrideHost: string;
|
|
24226
24326
|
/**
|
|
24227
|
-
*
|
|
24327
|
+
* Defines a an IP or set of IPs for overriding matched DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
24228
24328
|
*/
|
|
24229
24329
|
overrideIps: string[];
|
|
24230
24330
|
/**
|
|
24231
|
-
* Configure DLP payload logging.
|
|
24331
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
24232
24332
|
*/
|
|
24233
24333
|
payloadLog: outputs.GetZeroTrustGatewayPolicyRuleSettingsPayloadLog;
|
|
24234
24334
|
/**
|
|
24235
|
-
*
|
|
24335
|
+
* Configure settings that apply to quarantine rules. Settable only for `http` rules.
|
|
24236
24336
|
*/
|
|
24237
24337
|
quarantine: outputs.GetZeroTrustGatewayPolicyRuleSettingsQuarantine;
|
|
24238
24338
|
/**
|
|
24239
|
-
*
|
|
24339
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action set to `redirect`.
|
|
24240
24340
|
*/
|
|
24241
24341
|
redirect: outputs.GetZeroTrustGatewayPolicyRuleSettingsRedirect;
|
|
24242
24342
|
/**
|
|
24243
|
-
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input.
|
|
24343
|
+
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input. Not used when 'dns*resolvers' is specified or 'resolve*dns*through*cloudflare' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
24244
24344
|
*/
|
|
24245
24345
|
resolveDnsInternally: outputs.GetZeroTrustGatewayPolicyRuleSettingsResolveDnsInternally;
|
|
24246
24346
|
/**
|
|
24247
|
-
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot
|
|
24347
|
+
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot set when 'dns*resolvers' specified or 'resolve*dns_internally' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
24248
24348
|
*/
|
|
24249
24349
|
resolveDnsThroughCloudflare: boolean;
|
|
24250
24350
|
/**
|
|
24251
|
-
* Configure behavior when an upstream
|
|
24351
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error occurs. Settable only for `http` rules with the action set to `allow`.
|
|
24252
24352
|
*/
|
|
24253
24353
|
untrustedCert: outputs.GetZeroTrustGatewayPolicyRuleSettingsUntrustedCert;
|
|
24254
24354
|
}
|
|
24255
24355
|
export interface GetZeroTrustGatewayPolicyRuleSettingsAuditSsh {
|
|
24256
24356
|
/**
|
|
24257
|
-
* Enable
|
|
24357
|
+
* Enable SSH command logging.
|
|
24258
24358
|
*/
|
|
24259
24359
|
commandLogging: boolean;
|
|
24260
24360
|
}
|
|
24261
24361
|
export interface GetZeroTrustGatewayPolicyRuleSettingsBisoAdminControls {
|
|
24262
24362
|
/**
|
|
24263
|
-
* Configure
|
|
24363
|
+
* Configure copy behavior. If set to remote*only, users cannot copy isolated content from the remote browser to the local clipboard. If this field is absent, copying remains enabled. Applies only when version == "v2".
|
|
24264
24364
|
* Available values: "enabled", "disabled", "remote*only".
|
|
24265
24365
|
*/
|
|
24266
24366
|
copy: string;
|
|
@@ -24277,7 +24377,7 @@ export interface GetZeroTrustGatewayPolicyRuleSettingsBisoAdminControls {
|
|
|
24277
24377
|
*/
|
|
24278
24378
|
dk: boolean;
|
|
24279
24379
|
/**
|
|
24280
|
-
* Configure
|
|
24380
|
+
* Configure download behavior. When set to remote*only, users can view downloads but cannot save them. Applies only when version == "v2".
|
|
24281
24381
|
* Available values: "enabled", "disabled", "remote*only".
|
|
24282
24382
|
*/
|
|
24283
24383
|
download: string;
|
|
@@ -24290,45 +24390,48 @@ export interface GetZeroTrustGatewayPolicyRuleSettingsBisoAdminControls {
|
|
|
24290
24390
|
*/
|
|
24291
24391
|
du: boolean;
|
|
24292
24392
|
/**
|
|
24293
|
-
* Configure
|
|
24393
|
+
* Configure keyboard usage behavior. If this field is absent, keyboard usage remains enabled. Applies only when version == "v2".
|
|
24294
24394
|
* Available values: "enabled", "disabled".
|
|
24295
24395
|
*/
|
|
24296
24396
|
keyboard: string;
|
|
24297
24397
|
/**
|
|
24298
|
-
* Configure
|
|
24398
|
+
* Configure paste behavior. If set to remote*only, users cannot paste content from the local clipboard into isolated pages. If this field is absent, pasting remains enabled. Applies only when version == "v2".
|
|
24299
24399
|
* Available values: "enabled", "disabled", "remote*only".
|
|
24300
24400
|
*/
|
|
24301
24401
|
paste: string;
|
|
24302
24402
|
/**
|
|
24303
|
-
* Configure
|
|
24403
|
+
* Configure print behavior. Default, Printing is enabled. Applies only when version == "v2".
|
|
24304
24404
|
* Available values: "enabled", "disabled".
|
|
24305
24405
|
*/
|
|
24306
24406
|
printing: string;
|
|
24307
24407
|
/**
|
|
24308
|
-
* Configure
|
|
24408
|
+
* Configure upload behavior. If this field is absent, uploading remains enabled. Applies only when version == "v2".
|
|
24309
24409
|
* Available values: "enabled", "disabled".
|
|
24310
24410
|
*/
|
|
24311
24411
|
upload: string;
|
|
24312
24412
|
/**
|
|
24313
|
-
*
|
|
24413
|
+
* Indicate which version of the browser isolation controls should apply.
|
|
24314
24414
|
* Available values: "v1", "v2".
|
|
24315
24415
|
*/
|
|
24316
24416
|
version: string;
|
|
24317
24417
|
}
|
|
24318
24418
|
export interface GetZeroTrustGatewayPolicyRuleSettingsBlockPage {
|
|
24319
24419
|
/**
|
|
24320
|
-
*
|
|
24420
|
+
* Specify whether to pass the context information as query parameters.
|
|
24321
24421
|
*/
|
|
24322
24422
|
includeContext: boolean;
|
|
24323
24423
|
/**
|
|
24324
|
-
* URI to which the user
|
|
24424
|
+
* Specify the URI to which the user is redirected.
|
|
24325
24425
|
*/
|
|
24326
24426
|
targetUri: string;
|
|
24327
24427
|
}
|
|
24328
24428
|
export interface GetZeroTrustGatewayPolicyRuleSettingsCheckSession {
|
|
24429
|
+
/**
|
|
24430
|
+
* Sets the required session freshness threshold. The API returns a normalized version of this value.
|
|
24431
|
+
*/
|
|
24329
24432
|
duration: string;
|
|
24330
24433
|
/**
|
|
24331
|
-
*
|
|
24434
|
+
* Enable session enforcement.
|
|
24332
24435
|
*/
|
|
24333
24436
|
enforce: boolean;
|
|
24334
24437
|
}
|
|
@@ -24338,71 +24441,71 @@ export interface GetZeroTrustGatewayPolicyRuleSettingsDnsResolvers {
|
|
|
24338
24441
|
}
|
|
24339
24442
|
export interface GetZeroTrustGatewayPolicyRuleSettingsDnsResolversIpv4 {
|
|
24340
24443
|
/**
|
|
24341
|
-
* IPv4 address of upstream resolver.
|
|
24444
|
+
* Specify the IPv4 address of the upstream resolver.
|
|
24342
24445
|
*/
|
|
24343
24446
|
ip: string;
|
|
24344
24447
|
/**
|
|
24345
|
-
*
|
|
24448
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
24346
24449
|
*/
|
|
24347
24450
|
port: number;
|
|
24348
24451
|
/**
|
|
24349
|
-
*
|
|
24452
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
24350
24453
|
*/
|
|
24351
24454
|
routeThroughPrivateNetwork: boolean;
|
|
24352
24455
|
/**
|
|
24353
|
-
*
|
|
24456
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
24354
24457
|
*/
|
|
24355
24458
|
vnetId: string;
|
|
24356
24459
|
}
|
|
24357
24460
|
export interface GetZeroTrustGatewayPolicyRuleSettingsDnsResolversIpv6 {
|
|
24358
24461
|
/**
|
|
24359
|
-
* IPv6 address of upstream resolver.
|
|
24462
|
+
* Specify the IPv6 address of the upstream resolver.
|
|
24360
24463
|
*/
|
|
24361
24464
|
ip: string;
|
|
24362
24465
|
/**
|
|
24363
|
-
*
|
|
24466
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
24364
24467
|
*/
|
|
24365
24468
|
port: number;
|
|
24366
24469
|
/**
|
|
24367
|
-
*
|
|
24470
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
24368
24471
|
*/
|
|
24369
24472
|
routeThroughPrivateNetwork: boolean;
|
|
24370
24473
|
/**
|
|
24371
|
-
*
|
|
24474
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
24372
24475
|
*/
|
|
24373
24476
|
vnetId: string;
|
|
24374
24477
|
}
|
|
24375
24478
|
export interface GetZeroTrustGatewayPolicyRuleSettingsEgress {
|
|
24376
24479
|
/**
|
|
24377
|
-
*
|
|
24480
|
+
* Specify the IPv4 address to use for egress.
|
|
24378
24481
|
*/
|
|
24379
24482
|
ipv4: string;
|
|
24380
24483
|
/**
|
|
24381
|
-
*
|
|
24484
|
+
* Specify the fallback IPv4 address to use for egress when the primary IPv4 fails. Set '0.0.0.0' to indicate local egress via WARP IPs.
|
|
24382
24485
|
*/
|
|
24383
24486
|
ipv4Fallback: string;
|
|
24384
24487
|
/**
|
|
24385
|
-
*
|
|
24488
|
+
* Specify the IPv6 range to use for egress.
|
|
24386
24489
|
*/
|
|
24387
24490
|
ipv6: string;
|
|
24388
24491
|
}
|
|
24389
24492
|
export interface GetZeroTrustGatewayPolicyRuleSettingsL4override {
|
|
24390
24493
|
/**
|
|
24391
|
-
* IPv4 or IPv6 address.
|
|
24494
|
+
* Defines the IPv4 or IPv6 address.
|
|
24392
24495
|
*/
|
|
24393
24496
|
ip: string;
|
|
24394
24497
|
/**
|
|
24395
|
-
*
|
|
24498
|
+
* Defines a port number to use for TCP/UDP overrides.
|
|
24396
24499
|
*/
|
|
24397
24500
|
port: number;
|
|
24398
24501
|
}
|
|
24399
24502
|
export interface GetZeroTrustGatewayPolicyRuleSettingsNotificationSettings {
|
|
24400
24503
|
/**
|
|
24401
|
-
*
|
|
24504
|
+
* Enable notification.
|
|
24402
24505
|
*/
|
|
24403
24506
|
enabled: boolean;
|
|
24404
24507
|
/**
|
|
24405
|
-
*
|
|
24508
|
+
* Indicates whether to pass the context information as query parameters.
|
|
24406
24509
|
*/
|
|
24407
24510
|
includeContext: boolean;
|
|
24408
24511
|
/**
|
|
@@ -24410,356 +24513,333 @@ export interface GetZeroTrustGatewayPolicyRuleSettingsNotificationSettings {
|
|
|
24410
24513
|
*/
|
|
24411
24514
|
msg: string;
|
|
24412
24515
|
/**
|
|
24413
|
-
*
|
|
24516
|
+
* Defines an optional URL to direct users to additional information. If unset, the notification opens a block page.
|
|
24414
24517
|
*/
|
|
24415
24518
|
supportUrl: string;
|
|
24416
24519
|
}
|
|
24417
24520
|
export interface GetZeroTrustGatewayPolicyRuleSettingsPayloadLog {
|
|
24418
24521
|
/**
|
|
24419
|
-
*
|
|
24522
|
+
* Enable DLP payload logging for this rule.
|
|
24420
24523
|
*/
|
|
24421
24524
|
enabled: boolean;
|
|
24422
24525
|
}
|
|
24423
24526
|
export interface GetZeroTrustGatewayPolicyRuleSettingsQuarantine {
|
|
24424
24527
|
/**
|
|
24425
|
-
*
|
|
24528
|
+
* Specify the types of files to sandbox.
|
|
24426
24529
|
*/
|
|
24427
24530
|
fileTypes: string[];
|
|
24428
24531
|
}
|
|
24429
24532
|
export interface GetZeroTrustGatewayPolicyRuleSettingsRedirect {
|
|
24430
24533
|
/**
|
|
24431
|
-
*
|
|
24534
|
+
* Specify whether to pass the context information as query parameters.
|
|
24432
24535
|
*/
|
|
24433
24536
|
includeContext: boolean;
|
|
24434
24537
|
/**
|
|
24435
|
-
*
|
|
24538
|
+
* Specify whether to append the path and query parameters from the original request to target_uri.
|
|
24436
24539
|
*/
|
|
24437
24540
|
preservePathAndQuery: boolean;
|
|
24438
24541
|
/**
|
|
24439
|
-
* URI to which the user
|
|
24542
|
+
* Specify the URI to which the user is redirected.
|
|
24440
24543
|
*/
|
|
24441
24544
|
targetUri: string;
|
|
24442
24545
|
}
|
|
24443
24546
|
export interface GetZeroTrustGatewayPolicyRuleSettingsResolveDnsInternally {
|
|
24444
24547
|
/**
|
|
24445
|
-
*
|
|
24548
|
+
* Specify the fallback behavior to apply when the internal DNS response code differs from 'NOERROR' or when the response data contains only CNAME records for 'A' or 'AAAA' queries.
|
|
24446
24549
|
* Available values: "none", "publicDns".
|
|
24447
24550
|
*/
|
|
24448
24551
|
fallback: string;
|
|
24449
24552
|
/**
|
|
24450
|
-
*
|
|
24553
|
+
* Specify the internal DNS view identifier to pass to the internal DNS service.
|
|
24451
24554
|
*/
|
|
24452
24555
|
viewId: string;
|
|
24453
24556
|
}
|
|
24454
24557
|
export interface GetZeroTrustGatewayPolicyRuleSettingsUntrustedCert {
|
|
24455
24558
|
/**
|
|
24456
|
-
*
|
|
24559
|
+
* Defines the action performed when an untrusted certificate seen. The default action an error with HTTP code 526.
|
|
24457
24560
|
* Available values: "passThrough", "block", "error".
|
|
24458
24561
|
*/
|
|
24459
24562
|
action: string;
|
|
24460
24563
|
}
|
|
24461
24564
|
export interface GetZeroTrustGatewayPolicySchedule {
|
|
24462
|
-
/**
|
|
24463
|
-
* The time intervals when the rule will be active on Fridays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Fridays.
|
|
24464
|
-
*/
|
|
24465
24565
|
fri: string;
|
|
24466
|
-
/**
|
|
24467
|
-
* The time intervals when the rule will be active on Mondays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Mondays.
|
|
24468
|
-
*/
|
|
24469
24566
|
mon: string;
|
|
24470
|
-
/**
|
|
24471
|
-
* The time intervals when the rule will be active on Saturdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Saturdays.
|
|
24472
|
-
*/
|
|
24473
24567
|
sat: string;
|
|
24474
|
-
/**
|
|
24475
|
-
* The time intervals when the rule will be active on Sundays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Sundays.
|
|
24476
|
-
*/
|
|
24477
24568
|
sun: string;
|
|
24478
|
-
/**
|
|
24479
|
-
* The time intervals when the rule will be active on Thursdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Thursdays.
|
|
24480
|
-
*/
|
|
24481
24569
|
thu: string;
|
|
24482
24570
|
/**
|
|
24483
|
-
*
|
|
24571
|
+
* Specify the time zone for rule evaluation. When a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway always uses the current time for that time zone. When this parameter is omitted, Gateway uses the time zone determined from the user's IP address. Colo time zone is used when the user's IP address does not resolve to a location.
|
|
24484
24572
|
*/
|
|
24485
24573
|
timeZone: string;
|
|
24486
|
-
/**
|
|
24487
|
-
* The time intervals when the rule will be active on Tuesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Tuesdays.
|
|
24488
|
-
*/
|
|
24489
24574
|
tue: string;
|
|
24490
|
-
/**
|
|
24491
|
-
* The time intervals when the rule will be active on Wednesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Wednesdays.
|
|
24492
|
-
*/
|
|
24493
24575
|
wed: string;
|
|
24494
24576
|
}
|
|
24495
24577
|
export interface GetZeroTrustGatewaySettingsSettings {
|
|
24496
24578
|
/**
|
|
24497
|
-
*
|
|
24579
|
+
* Specify activity log settings.
|
|
24498
24580
|
*/
|
|
24499
24581
|
activityLog: outputs.GetZeroTrustGatewaySettingsSettingsActivityLog;
|
|
24500
24582
|
/**
|
|
24501
|
-
*
|
|
24583
|
+
* Specify anti-virus settings.
|
|
24502
24584
|
*/
|
|
24503
24585
|
antivirus: outputs.GetZeroTrustGatewaySettingsSettingsAntivirus;
|
|
24504
24586
|
/**
|
|
24505
|
-
*
|
|
24587
|
+
* Specify block page layout settings.
|
|
24506
24588
|
*/
|
|
24507
24589
|
blockPage: outputs.GetZeroTrustGatewaySettingsSettingsBlockPage;
|
|
24508
24590
|
/**
|
|
24509
|
-
* DLP
|
|
24591
|
+
* Specify the DLP inspection mode.
|
|
24510
24592
|
*/
|
|
24511
24593
|
bodyScanning: outputs.GetZeroTrustGatewaySettingsSettingsBodyScanning;
|
|
24512
24594
|
/**
|
|
24513
|
-
* Browser
|
|
24595
|
+
* Specify Clientless Browser Isolation settings.
|
|
24514
24596
|
*/
|
|
24515
24597
|
browserIsolation: outputs.GetZeroTrustGatewaySettingsSettingsBrowserIsolation;
|
|
24516
24598
|
/**
|
|
24517
|
-
*
|
|
24599
|
+
* Specify certificate settings for Gateway TLS interception. If unset, the Cloudflare Root CA handles interception.
|
|
24518
24600
|
*/
|
|
24519
24601
|
certificate: outputs.GetZeroTrustGatewaySettingsSettingsCertificate;
|
|
24520
24602
|
/**
|
|
24521
|
-
*
|
|
24603
|
+
* Specify custom certificate settings for BYO-PKI. This field is deprecated; use `certificate` instead.
|
|
24522
24604
|
*
|
|
24523
24605
|
* @deprecated This attribute is deprecated.
|
|
24524
24606
|
*/
|
|
24525
24607
|
customCertificate: outputs.GetZeroTrustGatewaySettingsSettingsCustomCertificate;
|
|
24526
24608
|
/**
|
|
24527
|
-
*
|
|
24609
|
+
* Specify user email settings for the firewall policies. When this is enabled, we standardize the email addresses in the identity part of the rule, so that they match the extended email variants in the firewall policies. When this setting is turned off, the email addresses in the identity part of the rule will be matched exactly as provided. If your email has `.` or `+` modifiers, you should enable this setting.
|
|
24528
24610
|
*/
|
|
24529
24611
|
extendedEmailMatching: outputs.GetZeroTrustGatewaySettingsSettingsExtendedEmailMatching;
|
|
24530
24612
|
/**
|
|
24531
|
-
* FIPS settings.
|
|
24613
|
+
* Specify FIPS settings.
|
|
24532
24614
|
*/
|
|
24533
24615
|
fips: outputs.GetZeroTrustGatewaySettingsSettingsFips;
|
|
24534
24616
|
/**
|
|
24535
|
-
*
|
|
24617
|
+
* Enable host selection in egress policies.
|
|
24536
24618
|
*/
|
|
24537
24619
|
hostSelector: outputs.GetZeroTrustGatewaySettingsSettingsHostSelector;
|
|
24538
24620
|
/**
|
|
24539
|
-
*
|
|
24621
|
+
* Define the proxy inspection mode.
|
|
24540
24622
|
*/
|
|
24541
24623
|
inspection: outputs.GetZeroTrustGatewaySettingsSettingsInspection;
|
|
24542
24624
|
/**
|
|
24543
|
-
*
|
|
24625
|
+
* Specify whether to detect protocols from the initial bytes of client traffic.
|
|
24544
24626
|
*/
|
|
24545
24627
|
protocolDetection: outputs.GetZeroTrustGatewaySettingsSettingsProtocolDetection;
|
|
24546
24628
|
/**
|
|
24547
|
-
*
|
|
24629
|
+
* Specify whether to enable the sandbox.
|
|
24548
24630
|
*/
|
|
24549
24631
|
sandbox: outputs.GetZeroTrustGatewaySettingsSettingsSandbox;
|
|
24550
24632
|
/**
|
|
24551
|
-
*
|
|
24633
|
+
* Specify whether to inspect encrypted HTTP traffic.
|
|
24552
24634
|
*/
|
|
24553
24635
|
tlsDecrypt: outputs.GetZeroTrustGatewaySettingsSettingsTlsDecrypt;
|
|
24554
24636
|
}
|
|
24555
24637
|
export interface GetZeroTrustGatewaySettingsSettingsActivityLog {
|
|
24556
24638
|
/**
|
|
24557
|
-
*
|
|
24639
|
+
* Specify whether to log activity.
|
|
24558
24640
|
*/
|
|
24559
24641
|
enabled: boolean;
|
|
24560
24642
|
}
|
|
24561
24643
|
export interface GetZeroTrustGatewaySettingsSettingsAntivirus {
|
|
24562
24644
|
/**
|
|
24563
|
-
*
|
|
24645
|
+
* Specify whether to enable anti-virus scanning on downloads.
|
|
24564
24646
|
*/
|
|
24565
24647
|
enabledDownloadPhase: boolean;
|
|
24566
24648
|
/**
|
|
24567
|
-
*
|
|
24649
|
+
* Specify whether to enable anti-virus scanning on uploads.
|
|
24568
24650
|
*/
|
|
24569
24651
|
enabledUploadPhase: boolean;
|
|
24570
24652
|
/**
|
|
24571
|
-
*
|
|
24653
|
+
* Specify whether to block requests for unscannable files.
|
|
24572
24654
|
*/
|
|
24573
24655
|
failClosed: boolean;
|
|
24574
24656
|
/**
|
|
24575
|
-
* Configure
|
|
24657
|
+
* Configure the message the user's device shows during an antivirus scan.
|
|
24576
24658
|
*/
|
|
24577
24659
|
notificationSettings: outputs.GetZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings;
|
|
24578
24660
|
}
|
|
24579
24661
|
export interface GetZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings {
|
|
24580
24662
|
/**
|
|
24581
|
-
*
|
|
24663
|
+
* Specify whether to enable notifications.
|
|
24582
24664
|
*/
|
|
24583
24665
|
enabled: boolean;
|
|
24584
24666
|
/**
|
|
24585
|
-
*
|
|
24667
|
+
* Specify whether to include context information as query parameters.
|
|
24586
24668
|
*/
|
|
24587
24669
|
includeContext: boolean;
|
|
24588
24670
|
/**
|
|
24589
|
-
*
|
|
24671
|
+
* Specify the message to show in the notification.
|
|
24590
24672
|
*/
|
|
24591
24673
|
msg: string;
|
|
24592
24674
|
/**
|
|
24593
|
-
*
|
|
24675
|
+
* Specify a URL that directs users to more information. If unset, the notification opens a block page.
|
|
24594
24676
|
*/
|
|
24595
24677
|
supportUrl: string;
|
|
24596
24678
|
}
|
|
24597
24679
|
export interface GetZeroTrustGatewaySettingsSettingsBlockPage {
|
|
24598
24680
|
/**
|
|
24599
|
-
*
|
|
24681
|
+
* Specify the block page background color in `#rrggbb` format when the mode is customized*block*page.
|
|
24600
24682
|
*/
|
|
24601
24683
|
backgroundColor: string;
|
|
24602
24684
|
/**
|
|
24603
|
-
*
|
|
24685
|
+
* Specify whether to enable the custom block page.
|
|
24604
24686
|
*/
|
|
24605
24687
|
enabled: boolean;
|
|
24606
24688
|
/**
|
|
24607
|
-
*
|
|
24689
|
+
* Specify the block page footer text when the mode is customized*block*page.
|
|
24608
24690
|
*/
|
|
24609
24691
|
footerText: string;
|
|
24610
24692
|
/**
|
|
24611
|
-
*
|
|
24693
|
+
* Specify the block page header text when the mode is customized*block*page.
|
|
24612
24694
|
*/
|
|
24613
24695
|
headerText: string;
|
|
24614
24696
|
/**
|
|
24615
|
-
*
|
|
24697
|
+
* Specify whether to append context to target*uri as query parameters. This applies only when the mode is redirect*uri.
|
|
24616
24698
|
*/
|
|
24617
24699
|
includeContext: boolean;
|
|
24618
24700
|
/**
|
|
24619
|
-
*
|
|
24701
|
+
* Specify the full URL to the logo file when the mode is customized*block*page.
|
|
24620
24702
|
*/
|
|
24621
24703
|
logoPath: string;
|
|
24622
24704
|
/**
|
|
24623
|
-
*
|
|
24705
|
+
* Specify the admin email for users to contact when the mode is customized*block*page.
|
|
24624
24706
|
*/
|
|
24625
24707
|
mailtoAddress: string;
|
|
24626
24708
|
/**
|
|
24627
|
-
*
|
|
24709
|
+
* Specify the subject line for emails created from the block page when the mode is customized*block*page.
|
|
24628
24710
|
*/
|
|
24629
24711
|
mailtoSubject: string;
|
|
24630
24712
|
/**
|
|
24631
|
-
*
|
|
24632
|
-
* Available values: "", "
|
|
24713
|
+
* Specify whether to redirect users to a Cloudflare-hosted block page or a customer-provided URI.
|
|
24714
|
+
* Available values: "", "customized*block*page", "redirectUri".
|
|
24633
24715
|
*/
|
|
24634
24716
|
mode: string;
|
|
24635
24717
|
/**
|
|
24636
|
-
*
|
|
24718
|
+
* Specify the block page title when the mode is customized*block*page.
|
|
24637
24719
|
*/
|
|
24638
24720
|
name: string;
|
|
24639
24721
|
/**
|
|
24640
|
-
*
|
|
24722
|
+
* Indicate that this setting was shared via the Orgs API and read only for the current account.
|
|
24641
24723
|
*/
|
|
24642
24724
|
readOnly: boolean;
|
|
24643
24725
|
/**
|
|
24644
|
-
*
|
|
24726
|
+
* Indicate the account tag of the account that shared this setting.
|
|
24645
24727
|
*/
|
|
24646
24728
|
sourceAccount: string;
|
|
24647
24729
|
/**
|
|
24648
|
-
*
|
|
24730
|
+
* Specify whether to suppress detailed information at the bottom of the block page when the mode is customized*block*page.
|
|
24649
24731
|
*/
|
|
24650
24732
|
suppressFooter: boolean;
|
|
24651
24733
|
/**
|
|
24652
|
-
*
|
|
24734
|
+
* Specify the URI to redirect users to when the mode is redirect_uri.
|
|
24653
24735
|
*/
|
|
24654
24736
|
targetUri: string;
|
|
24655
24737
|
/**
|
|
24656
|
-
*
|
|
24738
|
+
* Indicate the version number of the setting.
|
|
24657
24739
|
*/
|
|
24658
24740
|
version: number;
|
|
24659
24741
|
}
|
|
24660
24742
|
export interface GetZeroTrustGatewaySettingsSettingsBodyScanning {
|
|
24661
24743
|
/**
|
|
24662
|
-
*
|
|
24744
|
+
* Specify the inspection mode as either `deep` or `shallow`.
|
|
24663
24745
|
* Available values: "deep", "shallow".
|
|
24664
24746
|
*/
|
|
24665
24747
|
inspectionMode: string;
|
|
24666
24748
|
}
|
|
24667
24749
|
export interface GetZeroTrustGatewaySettingsSettingsBrowserIsolation {
|
|
24668
24750
|
/**
|
|
24669
|
-
*
|
|
24751
|
+
* Specify whether to enable non-identity onramp support for Browser Isolation.
|
|
24670
24752
|
*/
|
|
24671
24753
|
nonIdentityEnabled: boolean;
|
|
24672
24754
|
/**
|
|
24673
|
-
*
|
|
24755
|
+
* Specify whether to enable Clientless Browser Isolation.
|
|
24674
24756
|
*/
|
|
24675
24757
|
urlBrowserIsolationEnabled: boolean;
|
|
24676
24758
|
}
|
|
24677
24759
|
export interface GetZeroTrustGatewaySettingsSettingsCertificate {
|
|
24678
24760
|
/**
|
|
24679
|
-
* UUID of certificate
|
|
24761
|
+
* Specify the UUID of the certificate used for interception. Ensure the certificate is available at the edge(previously called 'active'). A nil UUID directs Cloudflare to use the Root CA.
|
|
24680
24762
|
*/
|
|
24681
24763
|
id: string;
|
|
24682
24764
|
}
|
|
24683
24765
|
export interface GetZeroTrustGatewaySettingsSettingsCustomCertificate {
|
|
24684
24766
|
/**
|
|
24685
|
-
*
|
|
24767
|
+
* Indicate the internal certificate status.
|
|
24686
24768
|
*/
|
|
24687
24769
|
bindingStatus: string;
|
|
24688
24770
|
/**
|
|
24689
|
-
*
|
|
24771
|
+
* Specify whether to enable a custom certificate authority for signing Gateway traffic.
|
|
24690
24772
|
*/
|
|
24691
24773
|
enabled: boolean;
|
|
24692
24774
|
/**
|
|
24693
|
-
* UUID of certificate (ID from MTLS certificate store).
|
|
24775
|
+
* Specify the UUID of the certificate (ID from MTLS certificate store).
|
|
24694
24776
|
*/
|
|
24695
24777
|
id: string;
|
|
24696
24778
|
updatedAt: string;
|
|
24697
24779
|
}
|
|
24698
24780
|
export interface GetZeroTrustGatewaySettingsSettingsExtendedEmailMatching {
|
|
24699
24781
|
/**
|
|
24700
|
-
*
|
|
24782
|
+
* Specify whether to match all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.
|
|
24701
24783
|
*/
|
|
24702
24784
|
enabled: boolean;
|
|
24703
24785
|
/**
|
|
24704
|
-
*
|
|
24786
|
+
* Indicate that this setting was shared via the Orgs API and read only for the current account.
|
|
24705
24787
|
*/
|
|
24706
24788
|
readOnly: boolean;
|
|
24707
24789
|
/**
|
|
24708
|
-
*
|
|
24790
|
+
* Indicate the account tag of the account that shared this setting.
|
|
24709
24791
|
*/
|
|
24710
24792
|
sourceAccount: string;
|
|
24711
24793
|
/**
|
|
24712
|
-
*
|
|
24794
|
+
* Indicate the version number of the setting.
|
|
24713
24795
|
*/
|
|
24714
24796
|
version: number;
|
|
24715
24797
|
}
|
|
24716
24798
|
export interface GetZeroTrustGatewaySettingsSettingsFips {
|
|
24717
24799
|
/**
|
|
24718
|
-
*
|
|
24800
|
+
* Enforce cipher suites and TLS versions compliant with FIPS 140-2.
|
|
24719
24801
|
*/
|
|
24720
24802
|
tls: boolean;
|
|
24721
24803
|
}
|
|
24722
24804
|
export interface GetZeroTrustGatewaySettingsSettingsHostSelector {
|
|
24723
24805
|
/**
|
|
24724
|
-
*
|
|
24806
|
+
* Specify whether to enable filtering via hosts for egress policies.
|
|
24725
24807
|
*/
|
|
24726
24808
|
enabled: boolean;
|
|
24727
24809
|
}
|
|
24728
24810
|
export interface GetZeroTrustGatewaySettingsSettingsInspection {
|
|
24729
24811
|
/**
|
|
24730
|
-
*
|
|
24731
|
-
* - static: Gateway will use static inspection to inspect HTTP on TCP(80). If TLS decryption is on, Gateway will inspect HTTPS traffic on TCP(443) & UDP(443).
|
|
24732
|
-
* - dynamic: Gateway will use protocol detection to dynamically inspect HTTP and HTTPS traffic on any port. TLS decryption must be on to inspect HTTPS traffic.
|
|
24812
|
+
* Define the proxy inspection mode. 1. static: Gateway applies static inspection to HTTP on TCP(80). With TLS decryption on, Gateway inspects HTTPS traffic on TCP(443) and UDP(443). 2. dynamic: Gateway applies protocol detection to inspect HTTP and HTTPS traffic on any port. TLS decryption must remain on to inspect HTTPS traffic.
|
|
24733
24813
|
* Available values: "static", "dynamic".
|
|
24734
24814
|
*/
|
|
24735
24815
|
mode: string;
|
|
24736
24816
|
}
|
|
24737
24817
|
export interface GetZeroTrustGatewaySettingsSettingsProtocolDetection {
|
|
24738
24818
|
/**
|
|
24739
|
-
*
|
|
24819
|
+
* Specify whether to detect protocols from the initial bytes of client traffic.
|
|
24740
24820
|
*/
|
|
24741
24821
|
enabled: boolean;
|
|
24742
24822
|
}
|
|
24743
24823
|
export interface GetZeroTrustGatewaySettingsSettingsSandbox {
|
|
24744
24824
|
/**
|
|
24745
|
-
*
|
|
24825
|
+
* Specify whether to enable the sandbox.
|
|
24746
24826
|
*/
|
|
24747
24827
|
enabled: boolean;
|
|
24748
24828
|
/**
|
|
24749
|
-
*
|
|
24829
|
+
* Specify the action to take when the system cannot scan the file.
|
|
24750
24830
|
* Available values: "allow", "block".
|
|
24751
24831
|
*/
|
|
24752
24832
|
fallbackAction: string;
|
|
24753
24833
|
}
|
|
24754
24834
|
export interface GetZeroTrustGatewaySettingsSettingsTlsDecrypt {
|
|
24755
24835
|
/**
|
|
24756
|
-
*
|
|
24836
|
+
* Specify whether to inspect encrypted HTTP traffic.
|
|
24757
24837
|
*/
|
|
24758
24838
|
enabled: boolean;
|
|
24759
24839
|
}
|
|
24760
24840
|
export interface GetZeroTrustListFilter {
|
|
24761
24841
|
/**
|
|
24762
|
-
*
|
|
24842
|
+
* Specify the list type.
|
|
24763
24843
|
* Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP".
|
|
24764
24844
|
*/
|
|
24765
24845
|
type?: string;
|
|
@@ -24767,38 +24847,38 @@ export interface GetZeroTrustListFilter {
|
|
|
24767
24847
|
export interface GetZeroTrustListItem {
|
|
24768
24848
|
createdAt: string;
|
|
24769
24849
|
/**
|
|
24770
|
-
*
|
|
24850
|
+
* Provide the list item description (optional).
|
|
24771
24851
|
*/
|
|
24772
24852
|
description: string;
|
|
24773
24853
|
/**
|
|
24774
|
-
*
|
|
24854
|
+
* Specify the item value.
|
|
24775
24855
|
*/
|
|
24776
24856
|
value: string;
|
|
24777
24857
|
}
|
|
24778
24858
|
export interface GetZeroTrustListsResult {
|
|
24779
24859
|
createdAt: string;
|
|
24780
24860
|
/**
|
|
24781
|
-
*
|
|
24861
|
+
* Provide the list description.
|
|
24782
24862
|
*/
|
|
24783
24863
|
description: string;
|
|
24784
24864
|
/**
|
|
24785
|
-
* API
|
|
24865
|
+
* Identify the API resource with a UUID.
|
|
24786
24866
|
*/
|
|
24787
24867
|
id: string;
|
|
24788
24868
|
/**
|
|
24789
|
-
*
|
|
24869
|
+
* Provide the list items.
|
|
24790
24870
|
*/
|
|
24791
24871
|
items: outputs.GetZeroTrustListsResultItem[];
|
|
24792
24872
|
/**
|
|
24793
|
-
*
|
|
24873
|
+
* Indicate the number of items in the list.
|
|
24794
24874
|
*/
|
|
24795
24875
|
listCount: number;
|
|
24796
24876
|
/**
|
|
24797
|
-
*
|
|
24877
|
+
* Specify the list name.
|
|
24798
24878
|
*/
|
|
24799
24879
|
name: string;
|
|
24800
24880
|
/**
|
|
24801
|
-
*
|
|
24881
|
+
* Specify the list type.
|
|
24802
24882
|
* Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP".
|
|
24803
24883
|
*/
|
|
24804
24884
|
type: string;
|
|
@@ -24807,14 +24887,70 @@ export interface GetZeroTrustListsResult {
|
|
|
24807
24887
|
export interface GetZeroTrustListsResultItem {
|
|
24808
24888
|
createdAt: string;
|
|
24809
24889
|
/**
|
|
24810
|
-
*
|
|
24890
|
+
* Provide the list item description (optional).
|
|
24811
24891
|
*/
|
|
24812
24892
|
description: string;
|
|
24813
24893
|
/**
|
|
24814
|
-
*
|
|
24894
|
+
* Specify the item value.
|
|
24815
24895
|
*/
|
|
24816
24896
|
value: string;
|
|
24817
24897
|
}
|
|
24898
|
+
export interface GetZeroTrustNetworkHostnameRouteFilter {
|
|
24899
|
+
/**
|
|
24900
|
+
* If set, only list hostname routes with the given comment.
|
|
24901
|
+
*/
|
|
24902
|
+
comment?: string;
|
|
24903
|
+
/**
|
|
24904
|
+
* If provided, include only resources that were created (and not deleted) before this time. URL encoded.
|
|
24905
|
+
*/
|
|
24906
|
+
existedAt?: string;
|
|
24907
|
+
/**
|
|
24908
|
+
* If set, only list hostname routes that contain a substring of the given value, the filter is case-insensitive.
|
|
24909
|
+
*/
|
|
24910
|
+
hostname?: string;
|
|
24911
|
+
/**
|
|
24912
|
+
* The hostname route ID.
|
|
24913
|
+
*/
|
|
24914
|
+
id?: string;
|
|
24915
|
+
/**
|
|
24916
|
+
* If `true`, only return deleted hostname routes. If `false`, exclude deleted hostname routes.
|
|
24917
|
+
*/
|
|
24918
|
+
isDeleted: boolean;
|
|
24919
|
+
/**
|
|
24920
|
+
* If set, only list hostname routes that point to a specific tunnel.
|
|
24921
|
+
*/
|
|
24922
|
+
tunnelId?: string;
|
|
24923
|
+
}
|
|
24924
|
+
export interface GetZeroTrustNetworkHostnameRoutesResult {
|
|
24925
|
+
/**
|
|
24926
|
+
* An optional description of the hostname route.
|
|
24927
|
+
*/
|
|
24928
|
+
comment: string;
|
|
24929
|
+
/**
|
|
24930
|
+
* Timestamp of when the resource was created.
|
|
24931
|
+
*/
|
|
24932
|
+
createdAt: string;
|
|
24933
|
+
/**
|
|
24934
|
+
* Timestamp of when the resource was deleted. If `null`, the resource has not been deleted.
|
|
24935
|
+
*/
|
|
24936
|
+
deletedAt: string;
|
|
24937
|
+
/**
|
|
24938
|
+
* The hostname of the route.
|
|
24939
|
+
*/
|
|
24940
|
+
hostname: string;
|
|
24941
|
+
/**
|
|
24942
|
+
* The hostname route ID.
|
|
24943
|
+
*/
|
|
24944
|
+
id: string;
|
|
24945
|
+
/**
|
|
24946
|
+
* UUID of the tunnel.
|
|
24947
|
+
*/
|
|
24948
|
+
tunnelId: string;
|
|
24949
|
+
/**
|
|
24950
|
+
* A user-friendly name for a tunnel.
|
|
24951
|
+
*/
|
|
24952
|
+
tunnelName: string;
|
|
24953
|
+
}
|
|
24818
24954
|
export interface GetZeroTrustOrganizationCustomPages {
|
|
24819
24955
|
/**
|
|
24820
24956
|
* The uid of the custom page to use when a user is denied access after failing a non-identity rule.
|
|
@@ -24901,10 +25037,6 @@ export interface GetZeroTrustTunnelCloudflaredConfigConfig {
|
|
|
24901
25037
|
* Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
|
|
24902
25038
|
*/
|
|
24903
25039
|
originRequest: outputs.GetZeroTrustTunnelCloudflaredConfigConfigOriginRequest;
|
|
24904
|
-
/**
|
|
24905
|
-
* Enable private network access from WARP users to private network routes. This is enabled if the tunnel has an assigned route.
|
|
24906
|
-
*/
|
|
24907
|
-
warpRouting: outputs.GetZeroTrustTunnelCloudflaredConfigConfigWarpRouting;
|
|
24908
25040
|
}
|
|
24909
25041
|
export interface GetZeroTrustTunnelCloudflaredConfigConfigIngress {
|
|
24910
25042
|
/**
|
|
@@ -25062,9 +25194,6 @@ export interface GetZeroTrustTunnelCloudflaredConfigConfigOriginRequestAccess {
|
|
|
25062
25194
|
required: boolean;
|
|
25063
25195
|
teamName: string;
|
|
25064
25196
|
}
|
|
25065
|
-
export interface GetZeroTrustTunnelCloudflaredConfigConfigWarpRouting {
|
|
25066
|
-
enabled: boolean;
|
|
25067
|
-
}
|
|
25068
25197
|
export interface GetZeroTrustTunnelCloudflaredConnection {
|
|
25069
25198
|
/**
|
|
25070
25199
|
* UUID of the Cloudflare Tunnel connector.
|
|
@@ -25589,7 +25718,7 @@ export interface GetZoneDnsSettingsSoa {
|
|
|
25589
25718
|
*/
|
|
25590
25719
|
minTtl: number;
|
|
25591
25720
|
/**
|
|
25592
|
-
* The primary nameserver, which may be used for outbound zone transfers.
|
|
25721
|
+
* The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
|
|
25593
25722
|
*/
|
|
25594
25723
|
mname: string;
|
|
25595
25724
|
/**
|
|
@@ -29776,276 +29905,274 @@ export interface StreamWatermark {
|
|
|
29776
29905
|
}
|
|
29777
29906
|
export interface TeamsAccountSettings {
|
|
29778
29907
|
/**
|
|
29779
|
-
*
|
|
29908
|
+
* Specify activity log settings.
|
|
29780
29909
|
*/
|
|
29781
29910
|
activityLog?: outputs.TeamsAccountSettingsActivityLog;
|
|
29782
29911
|
/**
|
|
29783
|
-
*
|
|
29912
|
+
* Specify anti-virus settings.
|
|
29784
29913
|
*/
|
|
29785
29914
|
antivirus?: outputs.TeamsAccountSettingsAntivirus;
|
|
29786
29915
|
/**
|
|
29787
|
-
*
|
|
29916
|
+
* Specify block page layout settings.
|
|
29788
29917
|
*/
|
|
29789
29918
|
blockPage?: outputs.TeamsAccountSettingsBlockPage;
|
|
29790
29919
|
/**
|
|
29791
|
-
* DLP
|
|
29920
|
+
* Specify the DLP inspection mode.
|
|
29792
29921
|
*/
|
|
29793
29922
|
bodyScanning?: outputs.TeamsAccountSettingsBodyScanning;
|
|
29794
29923
|
/**
|
|
29795
|
-
* Browser
|
|
29924
|
+
* Specify Clientless Browser Isolation settings.
|
|
29796
29925
|
*/
|
|
29797
29926
|
browserIsolation?: outputs.TeamsAccountSettingsBrowserIsolation;
|
|
29798
29927
|
/**
|
|
29799
|
-
*
|
|
29928
|
+
* Specify certificate settings for Gateway TLS interception. If unset, the Cloudflare Root CA handles interception.
|
|
29800
29929
|
*/
|
|
29801
29930
|
certificate?: outputs.TeamsAccountSettingsCertificate;
|
|
29802
29931
|
/**
|
|
29803
|
-
*
|
|
29932
|
+
* Specify custom certificate settings for BYO-PKI. This field is deprecated; use `certificate` instead.
|
|
29804
29933
|
*
|
|
29805
29934
|
* @deprecated This attribute is deprecated.
|
|
29806
29935
|
*/
|
|
29807
29936
|
customCertificate?: outputs.TeamsAccountSettingsCustomCertificate;
|
|
29808
29937
|
/**
|
|
29809
|
-
*
|
|
29938
|
+
* Specify user email settings for the firewall policies. When this is enabled, we standardize the email addresses in the identity part of the rule, so that they match the extended email variants in the firewall policies. When this setting is turned off, the email addresses in the identity part of the rule will be matched exactly as provided. If your email has `.` or `+` modifiers, you should enable this setting.
|
|
29810
29939
|
*/
|
|
29811
29940
|
extendedEmailMatching?: outputs.TeamsAccountSettingsExtendedEmailMatching;
|
|
29812
29941
|
/**
|
|
29813
|
-
* FIPS settings.
|
|
29942
|
+
* Specify FIPS settings.
|
|
29814
29943
|
*/
|
|
29815
29944
|
fips?: outputs.TeamsAccountSettingsFips;
|
|
29816
29945
|
/**
|
|
29817
|
-
*
|
|
29946
|
+
* Enable host selection in egress policies.
|
|
29818
29947
|
*/
|
|
29819
29948
|
hostSelector?: outputs.TeamsAccountSettingsHostSelector;
|
|
29820
29949
|
/**
|
|
29821
|
-
*
|
|
29950
|
+
* Define the proxy inspection mode.
|
|
29822
29951
|
*/
|
|
29823
29952
|
inspection?: outputs.TeamsAccountSettingsInspection;
|
|
29824
29953
|
/**
|
|
29825
|
-
*
|
|
29954
|
+
* Specify whether to detect protocols from the initial bytes of client traffic.
|
|
29826
29955
|
*/
|
|
29827
29956
|
protocolDetection?: outputs.TeamsAccountSettingsProtocolDetection;
|
|
29828
29957
|
/**
|
|
29829
|
-
*
|
|
29958
|
+
* Specify whether to enable the sandbox.
|
|
29830
29959
|
*/
|
|
29831
29960
|
sandbox?: outputs.TeamsAccountSettingsSandbox;
|
|
29832
29961
|
/**
|
|
29833
|
-
*
|
|
29962
|
+
* Specify whether to inspect encrypted HTTP traffic.
|
|
29834
29963
|
*/
|
|
29835
29964
|
tlsDecrypt?: outputs.TeamsAccountSettingsTlsDecrypt;
|
|
29836
29965
|
}
|
|
29837
29966
|
export interface TeamsAccountSettingsActivityLog {
|
|
29838
29967
|
/**
|
|
29839
|
-
*
|
|
29968
|
+
* Specify whether to log activity.
|
|
29840
29969
|
*/
|
|
29841
29970
|
enabled?: boolean;
|
|
29842
29971
|
}
|
|
29843
29972
|
export interface TeamsAccountSettingsAntivirus {
|
|
29844
29973
|
/**
|
|
29845
|
-
*
|
|
29974
|
+
* Specify whether to enable anti-virus scanning on downloads.
|
|
29846
29975
|
*/
|
|
29847
29976
|
enabledDownloadPhase: boolean;
|
|
29848
29977
|
/**
|
|
29849
|
-
*
|
|
29978
|
+
* Specify whether to enable anti-virus scanning on uploads.
|
|
29850
29979
|
*/
|
|
29851
29980
|
enabledUploadPhase: boolean;
|
|
29852
29981
|
/**
|
|
29853
|
-
*
|
|
29982
|
+
* Specify whether to block requests for unscannable files.
|
|
29854
29983
|
*/
|
|
29855
29984
|
failClosed: boolean;
|
|
29856
29985
|
/**
|
|
29857
|
-
* Configure
|
|
29986
|
+
* Configure the message the user's device shows during an antivirus scan.
|
|
29858
29987
|
*/
|
|
29859
29988
|
notificationSettings: outputs.TeamsAccountSettingsAntivirusNotificationSettings;
|
|
29860
29989
|
}
|
|
29861
29990
|
export interface TeamsAccountSettingsAntivirusNotificationSettings {
|
|
29862
29991
|
/**
|
|
29863
|
-
*
|
|
29992
|
+
* Specify whether to enable notifications.
|
|
29864
29993
|
*/
|
|
29865
29994
|
enabled?: boolean;
|
|
29866
29995
|
/**
|
|
29867
|
-
*
|
|
29996
|
+
* Specify whether to include context information as query parameters.
|
|
29868
29997
|
*/
|
|
29869
29998
|
includeContext?: boolean;
|
|
29870
29999
|
/**
|
|
29871
|
-
*
|
|
30000
|
+
* Specify the message to show in the notification.
|
|
29872
30001
|
*/
|
|
29873
30002
|
msg?: string;
|
|
29874
30003
|
/**
|
|
29875
|
-
*
|
|
30004
|
+
* Specify a URL that directs users to more information. If unset, the notification opens a block page.
|
|
29876
30005
|
*/
|
|
29877
30006
|
supportUrl?: string;
|
|
29878
30007
|
}
|
|
29879
30008
|
export interface TeamsAccountSettingsBlockPage {
|
|
29880
30009
|
/**
|
|
29881
|
-
*
|
|
30010
|
+
* Specify the block page background color in `#rrggbb` format when the mode is customized*block*page.
|
|
29882
30011
|
*/
|
|
29883
30012
|
backgroundColor?: string;
|
|
29884
30013
|
/**
|
|
29885
|
-
*
|
|
30014
|
+
* Specify whether to enable the custom block page.
|
|
29886
30015
|
*/
|
|
29887
30016
|
enabled?: boolean;
|
|
29888
30017
|
/**
|
|
29889
|
-
*
|
|
30018
|
+
* Specify the block page footer text when the mode is customized*block*page.
|
|
29890
30019
|
*/
|
|
29891
30020
|
footerText?: string;
|
|
29892
30021
|
/**
|
|
29893
|
-
*
|
|
30022
|
+
* Specify the block page header text when the mode is customized*block*page.
|
|
29894
30023
|
*/
|
|
29895
30024
|
headerText?: string;
|
|
29896
30025
|
/**
|
|
29897
|
-
*
|
|
30026
|
+
* Specify whether to append context to target*uri as query parameters. This applies only when the mode is redirect*uri.
|
|
29898
30027
|
*/
|
|
29899
30028
|
includeContext?: boolean;
|
|
29900
30029
|
/**
|
|
29901
|
-
*
|
|
30030
|
+
* Specify the full URL to the logo file when the mode is customized*block*page.
|
|
29902
30031
|
*/
|
|
29903
30032
|
logoPath?: string;
|
|
29904
30033
|
/**
|
|
29905
|
-
*
|
|
30034
|
+
* Specify the admin email for users to contact when the mode is customized*block*page.
|
|
29906
30035
|
*/
|
|
29907
30036
|
mailtoAddress?: string;
|
|
29908
30037
|
/**
|
|
29909
|
-
*
|
|
30038
|
+
* Specify the subject line for emails created from the block page when the mode is customized*block*page.
|
|
29910
30039
|
*/
|
|
29911
30040
|
mailtoSubject?: string;
|
|
29912
30041
|
/**
|
|
29913
|
-
*
|
|
29914
|
-
* Available values: "", "
|
|
30042
|
+
* Specify whether to redirect users to a Cloudflare-hosted block page or a customer-provided URI.
|
|
30043
|
+
* Available values: "", "customized*block*page", "redirectUri".
|
|
29915
30044
|
*/
|
|
29916
30045
|
mode?: string;
|
|
29917
30046
|
/**
|
|
29918
|
-
*
|
|
30047
|
+
* Specify the block page title when the mode is customized*block*page.
|
|
29919
30048
|
*/
|
|
29920
30049
|
name?: string;
|
|
29921
30050
|
/**
|
|
29922
|
-
*
|
|
30051
|
+
* Indicate that this setting was shared via the Orgs API and read only for the current account.
|
|
29923
30052
|
*/
|
|
29924
30053
|
readOnly: boolean;
|
|
29925
30054
|
/**
|
|
29926
|
-
*
|
|
30055
|
+
* Indicate the account tag of the account that shared this setting.
|
|
29927
30056
|
*/
|
|
29928
30057
|
sourceAccount: string;
|
|
29929
30058
|
/**
|
|
29930
|
-
*
|
|
30059
|
+
* Specify whether to suppress detailed information at the bottom of the block page when the mode is customized*block*page.
|
|
29931
30060
|
*/
|
|
29932
30061
|
suppressFooter?: boolean;
|
|
29933
30062
|
/**
|
|
29934
|
-
*
|
|
30063
|
+
* Specify the URI to redirect users to when the mode is redirect_uri.
|
|
29935
30064
|
*/
|
|
29936
30065
|
targetUri?: string;
|
|
29937
30066
|
/**
|
|
29938
|
-
*
|
|
30067
|
+
* Indicate the version number of the setting.
|
|
29939
30068
|
*/
|
|
29940
30069
|
version: number;
|
|
29941
30070
|
}
|
|
29942
30071
|
export interface TeamsAccountSettingsBodyScanning {
|
|
29943
30072
|
/**
|
|
29944
|
-
*
|
|
30073
|
+
* Specify the inspection mode as either `deep` or `shallow`.
|
|
29945
30074
|
* Available values: "deep", "shallow".
|
|
29946
30075
|
*/
|
|
29947
30076
|
inspectionMode?: string;
|
|
29948
30077
|
}
|
|
29949
30078
|
export interface TeamsAccountSettingsBrowserIsolation {
|
|
29950
30079
|
/**
|
|
29951
|
-
*
|
|
30080
|
+
* Specify whether to enable non-identity onramp support for Browser Isolation.
|
|
29952
30081
|
*/
|
|
29953
30082
|
nonIdentityEnabled?: boolean;
|
|
29954
30083
|
/**
|
|
29955
|
-
*
|
|
30084
|
+
* Specify whether to enable Clientless Browser Isolation.
|
|
29956
30085
|
*/
|
|
29957
30086
|
urlBrowserIsolationEnabled?: boolean;
|
|
29958
30087
|
}
|
|
29959
30088
|
export interface TeamsAccountSettingsCertificate {
|
|
29960
30089
|
/**
|
|
29961
|
-
* UUID of certificate
|
|
30090
|
+
* Specify the UUID of the certificate used for interception. Ensure the certificate is available at the edge(previously called 'active'). A nil UUID directs Cloudflare to use the Root CA.
|
|
29962
30091
|
*/
|
|
29963
30092
|
id: string;
|
|
29964
30093
|
}
|
|
29965
30094
|
export interface TeamsAccountSettingsCustomCertificate {
|
|
29966
30095
|
/**
|
|
29967
|
-
*
|
|
30096
|
+
* Indicate the internal certificate status.
|
|
29968
30097
|
*/
|
|
29969
30098
|
bindingStatus: string;
|
|
29970
30099
|
/**
|
|
29971
|
-
*
|
|
30100
|
+
* Specify whether to enable a custom certificate authority for signing Gateway traffic.
|
|
29972
30101
|
*/
|
|
29973
30102
|
enabled: boolean;
|
|
29974
30103
|
/**
|
|
29975
|
-
* UUID of certificate (ID from MTLS certificate store).
|
|
30104
|
+
* Specify the UUID of the certificate (ID from MTLS certificate store).
|
|
29976
30105
|
*/
|
|
29977
30106
|
id?: string;
|
|
29978
30107
|
updatedAt: string;
|
|
29979
30108
|
}
|
|
29980
30109
|
export interface TeamsAccountSettingsExtendedEmailMatching {
|
|
29981
30110
|
/**
|
|
29982
|
-
*
|
|
30111
|
+
* Specify whether to match all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.
|
|
29983
30112
|
*/
|
|
29984
30113
|
enabled?: boolean;
|
|
29985
30114
|
/**
|
|
29986
|
-
*
|
|
30115
|
+
* Indicate that this setting was shared via the Orgs API and read only for the current account.
|
|
29987
30116
|
*/
|
|
29988
30117
|
readOnly: boolean;
|
|
29989
30118
|
/**
|
|
29990
|
-
*
|
|
30119
|
+
* Indicate the account tag of the account that shared this setting.
|
|
29991
30120
|
*/
|
|
29992
30121
|
sourceAccount: string;
|
|
29993
30122
|
/**
|
|
29994
|
-
*
|
|
30123
|
+
* Indicate the version number of the setting.
|
|
29995
30124
|
*/
|
|
29996
30125
|
version: number;
|
|
29997
30126
|
}
|
|
29998
30127
|
export interface TeamsAccountSettingsFips {
|
|
29999
30128
|
/**
|
|
30000
|
-
*
|
|
30129
|
+
* Enforce cipher suites and TLS versions compliant with FIPS 140-2.
|
|
30001
30130
|
*/
|
|
30002
30131
|
tls?: boolean;
|
|
30003
30132
|
}
|
|
30004
30133
|
export interface TeamsAccountSettingsHostSelector {
|
|
30005
30134
|
/**
|
|
30006
|
-
*
|
|
30135
|
+
* Specify whether to enable filtering via hosts for egress policies.
|
|
30007
30136
|
*/
|
|
30008
30137
|
enabled?: boolean;
|
|
30009
30138
|
}
|
|
30010
30139
|
export interface TeamsAccountSettingsInspection {
|
|
30011
30140
|
/**
|
|
30012
|
-
*
|
|
30013
|
-
* - static: Gateway will use static inspection to inspect HTTP on TCP(80). If TLS decryption is on, Gateway will inspect HTTPS traffic on TCP(443) & UDP(443).
|
|
30014
|
-
* - dynamic: Gateway will use protocol detection to dynamically inspect HTTP and HTTPS traffic on any port. TLS decryption must be on to inspect HTTPS traffic.
|
|
30141
|
+
* Define the proxy inspection mode. 1. static: Gateway applies static inspection to HTTP on TCP(80). With TLS decryption on, Gateway inspects HTTPS traffic on TCP(443) and UDP(443). 2. dynamic: Gateway applies protocol detection to inspect HTTP and HTTPS traffic on any port. TLS decryption must remain on to inspect HTTPS traffic.
|
|
30015
30142
|
* Available values: "static", "dynamic".
|
|
30016
30143
|
*/
|
|
30017
30144
|
mode?: string;
|
|
30018
30145
|
}
|
|
30019
30146
|
export interface TeamsAccountSettingsProtocolDetection {
|
|
30020
30147
|
/**
|
|
30021
|
-
*
|
|
30148
|
+
* Specify whether to detect protocols from the initial bytes of client traffic.
|
|
30022
30149
|
*/
|
|
30023
30150
|
enabled?: boolean;
|
|
30024
30151
|
}
|
|
30025
30152
|
export interface TeamsAccountSettingsSandbox {
|
|
30026
30153
|
/**
|
|
30027
|
-
*
|
|
30154
|
+
* Specify whether to enable the sandbox.
|
|
30028
30155
|
*/
|
|
30029
30156
|
enabled?: boolean;
|
|
30030
30157
|
/**
|
|
30031
|
-
*
|
|
30158
|
+
* Specify the action to take when the system cannot scan the file.
|
|
30032
30159
|
* Available values: "allow", "block".
|
|
30033
30160
|
*/
|
|
30034
30161
|
fallbackAction?: string;
|
|
30035
30162
|
}
|
|
30036
30163
|
export interface TeamsAccountSettingsTlsDecrypt {
|
|
30037
30164
|
/**
|
|
30038
|
-
*
|
|
30165
|
+
* Specify whether to inspect encrypted HTTP traffic.
|
|
30039
30166
|
*/
|
|
30040
30167
|
enabled?: boolean;
|
|
30041
30168
|
}
|
|
30042
30169
|
export interface TeamsListItem {
|
|
30043
30170
|
/**
|
|
30044
|
-
*
|
|
30171
|
+
* Provide the list item description (optional).
|
|
30045
30172
|
*/
|
|
30046
30173
|
description?: string;
|
|
30047
30174
|
/**
|
|
30048
|
-
*
|
|
30175
|
+
* Specify the item value.
|
|
30049
30176
|
*/
|
|
30050
30177
|
value?: string;
|
|
30051
30178
|
}
|
|
@@ -30057,264 +30184,266 @@ export interface TeamsLocationEndpoints {
|
|
|
30057
30184
|
}
|
|
30058
30185
|
export interface TeamsLocationEndpointsDoh {
|
|
30059
30186
|
/**
|
|
30060
|
-
*
|
|
30187
|
+
* Indicate whether the DOH endpoint is enabled for this location.
|
|
30061
30188
|
*/
|
|
30062
30189
|
enabled: boolean;
|
|
30063
30190
|
/**
|
|
30064
|
-
*
|
|
30191
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
30065
30192
|
*/
|
|
30066
30193
|
networks: outputs.TeamsLocationEndpointsDohNetwork[];
|
|
30067
30194
|
/**
|
|
30068
|
-
*
|
|
30195
|
+
* Specify whether the DOH endpoint requires user identity authentication.
|
|
30069
30196
|
*/
|
|
30070
30197
|
requireToken: boolean;
|
|
30071
30198
|
}
|
|
30072
30199
|
export interface TeamsLocationEndpointsDohNetwork {
|
|
30073
30200
|
/**
|
|
30074
|
-
*
|
|
30201
|
+
* Specify the IP address or IP CIDR.
|
|
30075
30202
|
*/
|
|
30076
30203
|
network: string;
|
|
30077
30204
|
}
|
|
30078
30205
|
export interface TeamsLocationEndpointsDot {
|
|
30079
30206
|
/**
|
|
30080
|
-
*
|
|
30207
|
+
* Indicate whether the DOT endpoint is enabled for this location.
|
|
30081
30208
|
*/
|
|
30082
30209
|
enabled: boolean;
|
|
30083
30210
|
/**
|
|
30084
|
-
*
|
|
30211
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
30085
30212
|
*/
|
|
30086
30213
|
networks: outputs.TeamsLocationEndpointsDotNetwork[];
|
|
30087
30214
|
}
|
|
30088
30215
|
export interface TeamsLocationEndpointsDotNetwork {
|
|
30089
30216
|
/**
|
|
30090
|
-
*
|
|
30217
|
+
* Specify the IP address or IP CIDR.
|
|
30091
30218
|
*/
|
|
30092
30219
|
network: string;
|
|
30093
30220
|
}
|
|
30094
30221
|
export interface TeamsLocationEndpointsIpv4 {
|
|
30095
30222
|
/**
|
|
30096
|
-
*
|
|
30223
|
+
* Indicate whether the IPv4 endpoint is enabled for this location.
|
|
30097
30224
|
*/
|
|
30098
30225
|
enabled: boolean;
|
|
30099
30226
|
}
|
|
30100
30227
|
export interface TeamsLocationEndpointsIpv6 {
|
|
30101
30228
|
/**
|
|
30102
|
-
*
|
|
30229
|
+
* Indicate whether the IPV6 endpoint is enabled for this location.
|
|
30103
30230
|
*/
|
|
30104
30231
|
enabled: boolean;
|
|
30105
30232
|
/**
|
|
30106
|
-
*
|
|
30233
|
+
* Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
30107
30234
|
*/
|
|
30108
30235
|
networks: outputs.TeamsLocationEndpointsIpv6Network[];
|
|
30109
30236
|
}
|
|
30110
30237
|
export interface TeamsLocationEndpointsIpv6Network {
|
|
30111
30238
|
/**
|
|
30112
|
-
*
|
|
30239
|
+
* Specify the IPv6 address or IPv6 CIDR.
|
|
30113
30240
|
*/
|
|
30114
30241
|
network: string;
|
|
30115
30242
|
}
|
|
30116
30243
|
export interface TeamsLocationNetwork {
|
|
30117
30244
|
/**
|
|
30118
|
-
*
|
|
30245
|
+
* Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24.
|
|
30119
30246
|
*/
|
|
30120
30247
|
network: string;
|
|
30121
30248
|
}
|
|
30122
30249
|
export interface TeamsRuleExpiration {
|
|
30123
30250
|
/**
|
|
30124
|
-
*
|
|
30251
|
+
* Defines the default duration a policy active in minutes. Must set in order to use the `resetExpiration` endpoint on this rule.
|
|
30125
30252
|
*/
|
|
30126
30253
|
duration?: number;
|
|
30127
30254
|
/**
|
|
30128
|
-
*
|
|
30255
|
+
* Indicates whether the policy is expired.
|
|
30129
30256
|
*/
|
|
30130
30257
|
expired: boolean;
|
|
30131
30258
|
/**
|
|
30132
|
-
*
|
|
30133
|
-
* applied.
|
|
30259
|
+
* Show the timestamp when the policy expires and stops applying. The value must follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets but converts them to the equivalent UTC+00:00 value and returns timestamps with a trailing Z. Expiration policies ignore client timezones and expire globally at the specified expiresAt time.
|
|
30134
30260
|
*/
|
|
30135
30261
|
expiresAt: string;
|
|
30136
30262
|
}
|
|
30137
30263
|
export interface TeamsRuleRuleSettings {
|
|
30138
30264
|
/**
|
|
30139
|
-
* Add custom headers to allowed requests
|
|
30265
|
+
* Add custom headers to allowed requests as key-value pairs. Use header names as keys that map to arrays of header values. Settable only for `http` rules with the action set to `allow`.
|
|
30140
30266
|
*/
|
|
30141
30267
|
addHeaders?: {
|
|
30142
30268
|
[key: string]: string[];
|
|
30143
30269
|
};
|
|
30144
30270
|
/**
|
|
30145
|
-
* Set
|
|
30271
|
+
* Set to enable MSP children to bypass this rule. Only parent MSP accounts can set this. this rule. Settable for all types of rules.
|
|
30146
30272
|
*/
|
|
30147
30273
|
allowChildBypass: boolean;
|
|
30148
30274
|
/**
|
|
30149
|
-
*
|
|
30275
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with `auditSsh` action.
|
|
30150
30276
|
*/
|
|
30151
30277
|
auditSsh?: outputs.TeamsRuleRuleSettingsAuditSsh;
|
|
30152
30278
|
/**
|
|
30153
|
-
* Configure
|
|
30279
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the action set to `isolate`.
|
|
30154
30280
|
*/
|
|
30155
30281
|
bisoAdminControls?: outputs.TeamsRuleRuleSettingsBisoAdminControls;
|
|
30156
30282
|
/**
|
|
30157
|
-
*
|
|
30283
|
+
* Configure custom block page settings. If missing or null, use the account settings. Settable only for `http` rules with the action set to `block`.
|
|
30158
30284
|
*/
|
|
30159
30285
|
blockPage?: outputs.TeamsRuleRuleSettingsBlockPage;
|
|
30160
30286
|
/**
|
|
30161
|
-
* Enable the custom block page.
|
|
30287
|
+
* Enable the custom block page. Settable only for `dns` rules with action `block`.
|
|
30162
30288
|
*/
|
|
30163
30289
|
blockPageEnabled: boolean;
|
|
30164
30290
|
/**
|
|
30165
|
-
*
|
|
30291
|
+
* Explain why the rule blocks the request. The custom block page shows this text (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action set to `block`.
|
|
30166
30292
|
*/
|
|
30167
30293
|
blockReason: string;
|
|
30168
30294
|
/**
|
|
30169
|
-
* Set
|
|
30295
|
+
* Set to enable MSP accounts to bypass their parent's rules. Only MSP child accounts can set this. Settable for all types of rules.
|
|
30170
30296
|
*/
|
|
30171
30297
|
bypassParentRule?: boolean;
|
|
30172
30298
|
/**
|
|
30173
|
-
* Configure
|
|
30299
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with the action set to `allow`.
|
|
30174
30300
|
*/
|
|
30175
30301
|
checkSession?: outputs.TeamsRuleRuleSettingsCheckSession;
|
|
30176
30302
|
/**
|
|
30177
|
-
*
|
|
30303
|
+
* Configure custom resolvers to route queries that match the resolver policy. Unused with 'resolve*dns*through*cloudflare' or 'resolve*dns*internally' settings. DNS queries get routed to the address closest to their origin. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
30178
30304
|
*/
|
|
30179
30305
|
dnsResolvers?: outputs.TeamsRuleRuleSettingsDnsResolvers;
|
|
30180
30306
|
/**
|
|
30181
|
-
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.
|
|
30307
|
+
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs. Settable only for `egress` rules.
|
|
30182
30308
|
*/
|
|
30183
30309
|
egress?: outputs.TeamsRuleRuleSettingsEgress;
|
|
30184
30310
|
/**
|
|
30185
|
-
*
|
|
30311
|
+
* Ignore category matches at CNAME domains in a response. When off, evaluate categories in this rule against all CNAME domain categories in the response. Settable only for `dns` and `dnsResolver` rules.
|
|
30186
30312
|
*/
|
|
30187
30313
|
ignoreCnameCategoryMatches: boolean;
|
|
30188
30314
|
/**
|
|
30189
|
-
*
|
|
30315
|
+
* Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE]. Settable only for `dns` rules.
|
|
30190
30316
|
*/
|
|
30191
30317
|
insecureDisableDnssecValidation: boolean;
|
|
30192
30318
|
/**
|
|
30193
|
-
*
|
|
30319
|
+
* Enable IPs in DNS resolver category blocks. The system blocks only domain name categories unless you enable this setting. Settable only for `dns` and `dnsResolver` rules.
|
|
30194
30320
|
*/
|
|
30195
30321
|
ipCategories: boolean;
|
|
30196
30322
|
/**
|
|
30197
|
-
*
|
|
30323
|
+
* Indicates whether to include IPs in DNS resolver indicator feed blocks. Default, indicator feeds block only domain names. Settable only for `dns` and `dnsResolver` rules.
|
|
30198
30324
|
*/
|
|
30199
30325
|
ipIndicatorFeeds: boolean;
|
|
30200
30326
|
/**
|
|
30201
|
-
* Send matching traffic to the supplied destination IP address
|
|
30327
|
+
* Send matching traffic to the supplied destination IP address and port. Settable only for `l4` rules with the action set to `l4Override`.
|
|
30202
30328
|
*/
|
|
30203
30329
|
l4override?: outputs.TeamsRuleRuleSettingsL4override;
|
|
30204
30330
|
/**
|
|
30205
|
-
* Configure a notification to display on the user's device when this rule
|
|
30331
|
+
* Configure a notification to display on the user's device when this rule matched. Settable for all types of rules with the action set to `block`.
|
|
30206
30332
|
*/
|
|
30207
30333
|
notificationSettings?: outputs.TeamsRuleRuleSettingsNotificationSettings;
|
|
30208
30334
|
/**
|
|
30209
|
-
*
|
|
30335
|
+
* Defines a hostname for override, for the matching DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
30210
30336
|
*/
|
|
30211
30337
|
overrideHost: string;
|
|
30212
30338
|
/**
|
|
30213
|
-
*
|
|
30339
|
+
* Defines a an IP or set of IPs for overriding matched DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
30214
30340
|
*/
|
|
30215
30341
|
overrideIps: string[];
|
|
30216
30342
|
/**
|
|
30217
|
-
* Configure DLP payload logging.
|
|
30343
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
30218
30344
|
*/
|
|
30219
30345
|
payloadLog?: outputs.TeamsRuleRuleSettingsPayloadLog;
|
|
30220
30346
|
/**
|
|
30221
|
-
*
|
|
30347
|
+
* Configure settings that apply to quarantine rules. Settable only for `http` rules.
|
|
30222
30348
|
*/
|
|
30223
30349
|
quarantine?: outputs.TeamsRuleRuleSettingsQuarantine;
|
|
30224
30350
|
/**
|
|
30225
|
-
*
|
|
30351
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action set to `redirect`.
|
|
30226
30352
|
*/
|
|
30227
30353
|
redirect?: outputs.TeamsRuleRuleSettingsRedirect;
|
|
30228
30354
|
/**
|
|
30229
|
-
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input.
|
|
30355
|
+
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input. Not used when 'dns*resolvers' is specified or 'resolve*dns*through*cloudflare' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
30230
30356
|
*/
|
|
30231
30357
|
resolveDnsInternally?: outputs.TeamsRuleRuleSettingsResolveDnsInternally;
|
|
30232
30358
|
/**
|
|
30233
|
-
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot
|
|
30359
|
+
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot set when 'dns*resolvers' specified or 'resolve*dns_internally' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
30234
30360
|
*/
|
|
30235
30361
|
resolveDnsThroughCloudflare: boolean;
|
|
30236
30362
|
/**
|
|
30237
|
-
* Configure behavior when an upstream
|
|
30363
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error occurs. Settable only for `http` rules with the action set to `allow`.
|
|
30238
30364
|
*/
|
|
30239
30365
|
untrustedCert?: outputs.TeamsRuleRuleSettingsUntrustedCert;
|
|
30240
30366
|
}
|
|
30241
30367
|
export interface TeamsRuleRuleSettingsAuditSsh {
|
|
30242
30368
|
/**
|
|
30243
|
-
* Enable
|
|
30369
|
+
* Enable SSH command logging.
|
|
30244
30370
|
*/
|
|
30245
30371
|
commandLogging?: boolean;
|
|
30246
30372
|
}
|
|
30247
30373
|
export interface TeamsRuleRuleSettingsBisoAdminControls {
|
|
30248
30374
|
/**
|
|
30249
|
-
* Configure
|
|
30375
|
+
* Configure copy behavior. If set to remote*only, users cannot copy isolated content from the remote browser to the local clipboard. If this field is absent, copying remains enabled. Applies only when version == "v2".
|
|
30250
30376
|
* Available values: "enabled", "disabled", "remote*only".
|
|
30251
30377
|
*/
|
|
30252
30378
|
copy?: string;
|
|
30253
30379
|
/**
|
|
30254
30380
|
* Set to false to enable copy-pasting. Only applies when `version == "v1"`.
|
|
30255
30381
|
*/
|
|
30256
|
-
dcp
|
|
30382
|
+
dcp?: boolean;
|
|
30257
30383
|
/**
|
|
30258
30384
|
* Set to false to enable downloading. Only applies when `version == "v1"`.
|
|
30259
30385
|
*/
|
|
30260
|
-
dd
|
|
30386
|
+
dd?: boolean;
|
|
30261
30387
|
/**
|
|
30262
30388
|
* Set to false to enable keyboard usage. Only applies when `version == "v1"`.
|
|
30263
30389
|
*/
|
|
30264
|
-
dk
|
|
30390
|
+
dk?: boolean;
|
|
30265
30391
|
/**
|
|
30266
|
-
* Configure
|
|
30392
|
+
* Configure download behavior. When set to remote*only, users can view downloads but cannot save them. Applies only when version == "v2".
|
|
30267
30393
|
* Available values: "enabled", "disabled", "remote*only".
|
|
30268
30394
|
*/
|
|
30269
30395
|
download?: string;
|
|
30270
30396
|
/**
|
|
30271
30397
|
* Set to false to enable printing. Only applies when `version == "v1"`.
|
|
30272
30398
|
*/
|
|
30273
|
-
dp
|
|
30399
|
+
dp?: boolean;
|
|
30274
30400
|
/**
|
|
30275
30401
|
* Set to false to enable uploading. Only applies when `version == "v1"`.
|
|
30276
30402
|
*/
|
|
30277
|
-
du
|
|
30403
|
+
du?: boolean;
|
|
30278
30404
|
/**
|
|
30279
|
-
* Configure
|
|
30405
|
+
* Configure keyboard usage behavior. If this field is absent, keyboard usage remains enabled. Applies only when version == "v2".
|
|
30280
30406
|
* Available values: "enabled", "disabled".
|
|
30281
30407
|
*/
|
|
30282
30408
|
keyboard?: string;
|
|
30283
30409
|
/**
|
|
30284
|
-
* Configure
|
|
30410
|
+
* Configure paste behavior. If set to remote*only, users cannot paste content from the local clipboard into isolated pages. If this field is absent, pasting remains enabled. Applies only when version == "v2".
|
|
30285
30411
|
* Available values: "enabled", "disabled", "remote*only".
|
|
30286
30412
|
*/
|
|
30287
30413
|
paste?: string;
|
|
30288
30414
|
/**
|
|
30289
|
-
* Configure
|
|
30415
|
+
* Configure print behavior. Default, Printing is enabled. Applies only when version == "v2".
|
|
30290
30416
|
* Available values: "enabled", "disabled".
|
|
30291
30417
|
*/
|
|
30292
30418
|
printing?: string;
|
|
30293
30419
|
/**
|
|
30294
|
-
* Configure
|
|
30420
|
+
* Configure upload behavior. If this field is absent, uploading remains enabled. Applies only when version == "v2".
|
|
30295
30421
|
* Available values: "enabled", "disabled".
|
|
30296
30422
|
*/
|
|
30297
30423
|
upload?: string;
|
|
30298
30424
|
/**
|
|
30299
|
-
*
|
|
30425
|
+
* Indicate which version of the browser isolation controls should apply.
|
|
30300
30426
|
* Available values: "v1", "v2".
|
|
30301
30427
|
*/
|
|
30302
30428
|
version: string;
|
|
30303
30429
|
}
|
|
30304
30430
|
export interface TeamsRuleRuleSettingsBlockPage {
|
|
30305
30431
|
/**
|
|
30306
|
-
*
|
|
30432
|
+
* Specify whether to pass the context information as query parameters.
|
|
30307
30433
|
*/
|
|
30308
30434
|
includeContext?: boolean;
|
|
30309
30435
|
/**
|
|
30310
|
-
* URI to which the user
|
|
30436
|
+
* Specify the URI to which the user is redirected.
|
|
30311
30437
|
*/
|
|
30312
30438
|
targetUri: string;
|
|
30313
30439
|
}
|
|
30314
30440
|
export interface TeamsRuleRuleSettingsCheckSession {
|
|
30441
|
+
/**
|
|
30442
|
+
* Sets the required session freshness threshold. The API returns a normalized version of this value.
|
|
30443
|
+
*/
|
|
30315
30444
|
duration?: string;
|
|
30316
30445
|
/**
|
|
30317
|
-
*
|
|
30446
|
+
* Enable session enforcement.
|
|
30318
30447
|
*/
|
|
30319
30448
|
enforce?: boolean;
|
|
30320
30449
|
}
|
|
@@ -30324,71 +30453,71 @@ export interface TeamsRuleRuleSettingsDnsResolvers {
|
|
|
30324
30453
|
}
|
|
30325
30454
|
export interface TeamsRuleRuleSettingsDnsResolversIpv4 {
|
|
30326
30455
|
/**
|
|
30327
|
-
* IPv4 address of upstream resolver.
|
|
30456
|
+
* Specify the IPv4 address of the upstream resolver.
|
|
30328
30457
|
*/
|
|
30329
30458
|
ip: string;
|
|
30330
30459
|
/**
|
|
30331
|
-
*
|
|
30460
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
30332
30461
|
*/
|
|
30333
30462
|
port?: number;
|
|
30334
30463
|
/**
|
|
30335
|
-
*
|
|
30464
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
30336
30465
|
*/
|
|
30337
30466
|
routeThroughPrivateNetwork?: boolean;
|
|
30338
30467
|
/**
|
|
30339
|
-
*
|
|
30468
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
30340
30469
|
*/
|
|
30341
30470
|
vnetId?: string;
|
|
30342
30471
|
}
|
|
30343
30472
|
export interface TeamsRuleRuleSettingsDnsResolversIpv6 {
|
|
30344
30473
|
/**
|
|
30345
|
-
* IPv6 address of upstream resolver.
|
|
30474
|
+
* Specify the IPv6 address of the upstream resolver.
|
|
30346
30475
|
*/
|
|
30347
30476
|
ip: string;
|
|
30348
30477
|
/**
|
|
30349
|
-
*
|
|
30478
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
30350
30479
|
*/
|
|
30351
30480
|
port?: number;
|
|
30352
30481
|
/**
|
|
30353
|
-
*
|
|
30482
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
30354
30483
|
*/
|
|
30355
30484
|
routeThroughPrivateNetwork?: boolean;
|
|
30356
30485
|
/**
|
|
30357
|
-
*
|
|
30486
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
30358
30487
|
*/
|
|
30359
30488
|
vnetId?: string;
|
|
30360
30489
|
}
|
|
30361
30490
|
export interface TeamsRuleRuleSettingsEgress {
|
|
30362
30491
|
/**
|
|
30363
|
-
*
|
|
30492
|
+
* Specify the IPv4 address to use for egress.
|
|
30364
30493
|
*/
|
|
30365
30494
|
ipv4?: string;
|
|
30366
30495
|
/**
|
|
30367
|
-
*
|
|
30496
|
+
* Specify the fallback IPv4 address to use for egress when the primary IPv4 fails. Set '0.0.0.0' to indicate local egress via WARP IPs.
|
|
30368
30497
|
*/
|
|
30369
30498
|
ipv4Fallback?: string;
|
|
30370
30499
|
/**
|
|
30371
|
-
*
|
|
30500
|
+
* Specify the IPv6 range to use for egress.
|
|
30372
30501
|
*/
|
|
30373
30502
|
ipv6?: string;
|
|
30374
30503
|
}
|
|
30375
30504
|
export interface TeamsRuleRuleSettingsL4override {
|
|
30376
30505
|
/**
|
|
30377
|
-
* IPv4 or IPv6 address.
|
|
30506
|
+
* Defines the IPv4 or IPv6 address.
|
|
30378
30507
|
*/
|
|
30379
30508
|
ip?: string;
|
|
30380
30509
|
/**
|
|
30381
|
-
*
|
|
30510
|
+
* Defines a port number to use for TCP/UDP overrides.
|
|
30382
30511
|
*/
|
|
30383
30512
|
port?: number;
|
|
30384
30513
|
}
|
|
30385
30514
|
export interface TeamsRuleRuleSettingsNotificationSettings {
|
|
30386
30515
|
/**
|
|
30387
|
-
*
|
|
30516
|
+
* Enable notification.
|
|
30388
30517
|
*/
|
|
30389
30518
|
enabled?: boolean;
|
|
30390
30519
|
/**
|
|
30391
|
-
*
|
|
30520
|
+
* Indicates whether to pass the context information as query parameters.
|
|
30392
30521
|
*/
|
|
30393
30522
|
includeContext?: boolean;
|
|
30394
30523
|
/**
|
|
@@ -30396,86 +30525,65 @@ export interface TeamsRuleRuleSettingsNotificationSettings {
|
|
|
30396
30525
|
*/
|
|
30397
30526
|
msg?: string;
|
|
30398
30527
|
/**
|
|
30399
|
-
*
|
|
30528
|
+
* Defines an optional URL to direct users to additional information. If unset, the notification opens a block page.
|
|
30400
30529
|
*/
|
|
30401
30530
|
supportUrl?: string;
|
|
30402
30531
|
}
|
|
30403
30532
|
export interface TeamsRuleRuleSettingsPayloadLog {
|
|
30404
30533
|
/**
|
|
30405
|
-
*
|
|
30534
|
+
* Enable DLP payload logging for this rule.
|
|
30406
30535
|
*/
|
|
30407
30536
|
enabled?: boolean;
|
|
30408
30537
|
}
|
|
30409
30538
|
export interface TeamsRuleRuleSettingsQuarantine {
|
|
30410
30539
|
/**
|
|
30411
|
-
*
|
|
30540
|
+
* Specify the types of files to sandbox.
|
|
30412
30541
|
*/
|
|
30413
30542
|
fileTypes?: string[];
|
|
30414
30543
|
}
|
|
30415
30544
|
export interface TeamsRuleRuleSettingsRedirect {
|
|
30416
30545
|
/**
|
|
30417
|
-
*
|
|
30546
|
+
* Specify whether to pass the context information as query parameters.
|
|
30418
30547
|
*/
|
|
30419
30548
|
includeContext?: boolean;
|
|
30420
30549
|
/**
|
|
30421
|
-
*
|
|
30550
|
+
* Specify whether to append the path and query parameters from the original request to target_uri.
|
|
30422
30551
|
*/
|
|
30423
30552
|
preservePathAndQuery?: boolean;
|
|
30424
30553
|
/**
|
|
30425
|
-
* URI to which the user
|
|
30554
|
+
* Specify the URI to which the user is redirected.
|
|
30426
30555
|
*/
|
|
30427
30556
|
targetUri: string;
|
|
30428
30557
|
}
|
|
30429
30558
|
export interface TeamsRuleRuleSettingsResolveDnsInternally {
|
|
30430
30559
|
/**
|
|
30431
|
-
*
|
|
30560
|
+
* Specify the fallback behavior to apply when the internal DNS response code differs from 'NOERROR' or when the response data contains only CNAME records for 'A' or 'AAAA' queries.
|
|
30432
30561
|
* Available values: "none", "publicDns".
|
|
30433
30562
|
*/
|
|
30434
30563
|
fallback?: string;
|
|
30435
30564
|
/**
|
|
30436
|
-
*
|
|
30565
|
+
* Specify the internal DNS view identifier to pass to the internal DNS service.
|
|
30437
30566
|
*/
|
|
30438
30567
|
viewId?: string;
|
|
30439
30568
|
}
|
|
30440
30569
|
export interface TeamsRuleRuleSettingsUntrustedCert {
|
|
30441
30570
|
/**
|
|
30442
|
-
*
|
|
30571
|
+
* Defines the action performed when an untrusted certificate seen. The default action an error with HTTP code 526.
|
|
30443
30572
|
* Available values: "passThrough", "block", "error".
|
|
30444
30573
|
*/
|
|
30445
30574
|
action?: string;
|
|
30446
30575
|
}
|
|
30447
30576
|
export interface TeamsRuleSchedule {
|
|
30448
|
-
/**
|
|
30449
|
-
* The time intervals when the rule will be active on Fridays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Fridays.
|
|
30450
|
-
*/
|
|
30451
30577
|
fri?: string;
|
|
30452
|
-
/**
|
|
30453
|
-
* The time intervals when the rule will be active on Mondays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Mondays.
|
|
30454
|
-
*/
|
|
30455
30578
|
mon?: string;
|
|
30456
|
-
/**
|
|
30457
|
-
* The time intervals when the rule will be active on Saturdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Saturdays.
|
|
30458
|
-
*/
|
|
30459
30579
|
sat?: string;
|
|
30460
|
-
/**
|
|
30461
|
-
* The time intervals when the rule will be active on Sundays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Sundays.
|
|
30462
|
-
*/
|
|
30463
30580
|
sun?: string;
|
|
30464
|
-
/**
|
|
30465
|
-
* The time intervals when the rule will be active on Thursdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Thursdays.
|
|
30466
|
-
*/
|
|
30467
30581
|
thu?: string;
|
|
30468
30582
|
/**
|
|
30469
|
-
*
|
|
30583
|
+
* Specify the time zone for rule evaluation. When a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway always uses the current time for that time zone. When this parameter is omitted, Gateway uses the time zone determined from the user's IP address. Colo time zone is used when the user's IP address does not resolve to a location.
|
|
30470
30584
|
*/
|
|
30471
30585
|
timeZone?: string;
|
|
30472
|
-
/**
|
|
30473
|
-
* The time intervals when the rule will be active on Tuesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Tuesdays.
|
|
30474
|
-
*/
|
|
30475
30586
|
tue?: string;
|
|
30476
|
-
/**
|
|
30477
|
-
* The time intervals when the rule will be active on Wednesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Wednesdays.
|
|
30478
|
-
*/
|
|
30479
30587
|
wed?: string;
|
|
30480
30588
|
}
|
|
30481
30589
|
export interface TunnelConfigConfig {
|
|
@@ -30833,10 +30941,18 @@ export interface WorkerObservabilityLogs {
|
|
|
30833
30941
|
invocationLogs: boolean;
|
|
30834
30942
|
}
|
|
30835
30943
|
export interface WorkerScriptAssets {
|
|
30944
|
+
/**
|
|
30945
|
+
* The SHA-256 hash of the asset manifest of files to upload.
|
|
30946
|
+
*/
|
|
30947
|
+
assetManifestSha256: string;
|
|
30836
30948
|
/**
|
|
30837
30949
|
* Configuration for assets within a Worker.
|
|
30838
30950
|
*/
|
|
30839
30951
|
config?: outputs.WorkerScriptAssetsConfig;
|
|
30952
|
+
/**
|
|
30953
|
+
* Path to the directory containing asset files to upload.
|
|
30954
|
+
*/
|
|
30955
|
+
directory?: string;
|
|
30840
30956
|
/**
|
|
30841
30957
|
* Token provided upon successful upload of all files from a registered manifest.
|
|
30842
30958
|
*/
|
|
@@ -30877,6 +30993,14 @@ export interface WorkerScriptBinding {
|
|
|
30877
30993
|
* Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
|
|
30878
30994
|
*/
|
|
30879
30995
|
algorithm?: string;
|
|
30996
|
+
/**
|
|
30997
|
+
* List of allowed destination addresses.
|
|
30998
|
+
*/
|
|
30999
|
+
allowedDestinationAddresses?: string[];
|
|
31000
|
+
/**
|
|
31001
|
+
* List of allowed sender addresses.
|
|
31002
|
+
*/
|
|
31003
|
+
allowedSenderAddresses?: string[];
|
|
30880
31004
|
/**
|
|
30881
31005
|
* R2 bucket to bind to.
|
|
30882
31006
|
*/
|
|
@@ -30893,6 +31017,10 @@ export interface WorkerScriptBinding {
|
|
|
30893
31017
|
* The name of the dataset to bind to.
|
|
30894
31018
|
*/
|
|
30895
31019
|
dataset?: string;
|
|
31020
|
+
/**
|
|
31021
|
+
* Destination address for the email.
|
|
31022
|
+
*/
|
|
31023
|
+
destinationAddress?: string;
|
|
30896
31024
|
/**
|
|
30897
31025
|
* The environment of the scriptName to bind to.
|
|
30898
31026
|
*/
|
|
@@ -30914,6 +31042,11 @@ export interface WorkerScriptBinding {
|
|
|
30914
31042
|
* JSON data to use.
|
|
30915
31043
|
*/
|
|
30916
31044
|
json?: string;
|
|
31045
|
+
/**
|
|
31046
|
+
* The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket.
|
|
31047
|
+
* Available values: "eu", "fedramp".
|
|
31048
|
+
*/
|
|
31049
|
+
jurisdiction?: string;
|
|
30917
31050
|
/**
|
|
30918
31051
|
* Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
|
|
30919
31052
|
*/
|
|
@@ -30934,10 +31067,18 @@ export interface WorkerScriptBinding {
|
|
|
30934
31067
|
* Namespace identifier tag.
|
|
30935
31068
|
*/
|
|
30936
31069
|
namespaceId: string;
|
|
31070
|
+
/**
|
|
31071
|
+
* The old name of the inherited binding. If set, the binding will be renamed from `oldName` to `name` in the new version. If not set, the binding will keep the same name between versions.
|
|
31072
|
+
*/
|
|
31073
|
+
oldName?: string;
|
|
30937
31074
|
/**
|
|
30938
31075
|
* Outbound worker.
|
|
30939
31076
|
*/
|
|
30940
31077
|
outbound?: outputs.WorkerScriptBindingOutbound;
|
|
31078
|
+
/**
|
|
31079
|
+
* The name of the file containing the data content. Only accepted for `service worker syntax` Workers.
|
|
31080
|
+
*/
|
|
31081
|
+
part?: string;
|
|
30941
31082
|
/**
|
|
30942
31083
|
* Name of the Pipeline to bind to.
|
|
30943
31084
|
*/
|
|
@@ -30968,13 +31109,17 @@ export interface WorkerScriptBinding {
|
|
|
30968
31109
|
text?: string;
|
|
30969
31110
|
/**
|
|
30970
31111
|
* The kind of resource that the binding provides.
|
|
30971
|
-
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "service", "tail*consumer", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow".
|
|
31112
|
+
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "data*blob", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "inherit", "images", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "send*email", "service", "tail*consumer", "text*blob", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow", "wasm*module".
|
|
30972
31113
|
*/
|
|
30973
31114
|
type: string;
|
|
30974
31115
|
/**
|
|
30975
31116
|
* Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
|
|
30976
31117
|
*/
|
|
30977
31118
|
usages?: string[];
|
|
31119
|
+
/**
|
|
31120
|
+
* Identifier for the version to inherit the binding from, which can be the version ID or the literal "latest" to inherit from the latest version. Defaults to inheriting the binding from the latest version.
|
|
31121
|
+
*/
|
|
31122
|
+
versionId?: string;
|
|
30978
31123
|
/**
|
|
30979
31124
|
* Name of the Workflow to bind to.
|
|
30980
31125
|
*/
|
|
@@ -31031,6 +31176,10 @@ export interface WorkerScriptObservability {
|
|
|
31031
31176
|
logs?: outputs.WorkerScriptObservabilityLogs;
|
|
31032
31177
|
}
|
|
31033
31178
|
export interface WorkerScriptObservabilityLogs {
|
|
31179
|
+
/**
|
|
31180
|
+
* A list of destinations where logs will be exported to.
|
|
31181
|
+
*/
|
|
31182
|
+
destinations?: string[];
|
|
31034
31183
|
/**
|
|
31035
31184
|
* Whether logs are enabled for the Worker.
|
|
31036
31185
|
*/
|
|
@@ -31043,6 +31192,10 @@ export interface WorkerScriptObservabilityLogs {
|
|
|
31043
31192
|
* Whether [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs) are enabled for the Worker.
|
|
31044
31193
|
*/
|
|
31045
31194
|
invocationLogs: boolean;
|
|
31195
|
+
/**
|
|
31196
|
+
* Whether log persistence is enabled for the Worker.
|
|
31197
|
+
*/
|
|
31198
|
+
persist: boolean;
|
|
31046
31199
|
}
|
|
31047
31200
|
export interface WorkerScriptPlacement {
|
|
31048
31201
|
/**
|
|
@@ -31105,32 +31258,52 @@ export interface WorkerVersionAnnotations {
|
|
|
31105
31258
|
workersTriggeredBy: string;
|
|
31106
31259
|
}
|
|
31107
31260
|
export interface WorkerVersionAssets {
|
|
31261
|
+
/**
|
|
31262
|
+
* The SHA-256 hash of the asset manifest of files to upload.
|
|
31263
|
+
*/
|
|
31264
|
+
assetManifestSha256: string;
|
|
31108
31265
|
/**
|
|
31109
31266
|
* Configuration for assets within a Worker.
|
|
31110
31267
|
*/
|
|
31111
|
-
config
|
|
31268
|
+
config: outputs.WorkerVersionAssetsConfig;
|
|
31269
|
+
/**
|
|
31270
|
+
* Path to the directory containing asset files to upload.
|
|
31271
|
+
*/
|
|
31272
|
+
directory?: string;
|
|
31273
|
+
/**
|
|
31274
|
+
* Token provided upon successful upload of all files from a registered manifest.
|
|
31275
|
+
*/
|
|
31276
|
+
jwt?: string;
|
|
31112
31277
|
}
|
|
31113
31278
|
export interface WorkerVersionAssetsConfig {
|
|
31114
31279
|
/**
|
|
31115
31280
|
* Determines the redirects and rewrites of requests for HTML content.
|
|
31116
31281
|
* Available values: "auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none".
|
|
31117
31282
|
*/
|
|
31118
|
-
htmlHandling
|
|
31283
|
+
htmlHandling: string;
|
|
31119
31284
|
/**
|
|
31120
31285
|
* Determines the response when a request does not match a static asset, and there is no Worker script.
|
|
31121
31286
|
* Available values: "none", "404-page", "single-page-application".
|
|
31122
31287
|
*/
|
|
31123
|
-
notFoundHandling
|
|
31288
|
+
notFoundHandling: string;
|
|
31124
31289
|
/**
|
|
31125
31290
|
* Contains a list path rules to control routing to either the Worker or assets. Glob (*) and negative (!) rules are supported. Rules must start with either '/' or '!/'. At least one non-negative rule must be provided, and negative rules have higher precedence than non-negative rules.
|
|
31126
31291
|
*/
|
|
31127
|
-
runWorkerFirsts
|
|
31292
|
+
runWorkerFirsts: string[];
|
|
31128
31293
|
}
|
|
31129
31294
|
export interface WorkerVersionBinding {
|
|
31130
31295
|
/**
|
|
31131
31296
|
* Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
|
|
31132
31297
|
*/
|
|
31133
31298
|
algorithm?: string;
|
|
31299
|
+
/**
|
|
31300
|
+
* List of allowed destination addresses.
|
|
31301
|
+
*/
|
|
31302
|
+
allowedDestinationAddresses?: string[];
|
|
31303
|
+
/**
|
|
31304
|
+
* List of allowed sender addresses.
|
|
31305
|
+
*/
|
|
31306
|
+
allowedSenderAddresses?: string[];
|
|
31134
31307
|
/**
|
|
31135
31308
|
* R2 bucket to bind to.
|
|
31136
31309
|
*/
|
|
@@ -31147,6 +31320,10 @@ export interface WorkerVersionBinding {
|
|
|
31147
31320
|
* The name of the dataset to bind to.
|
|
31148
31321
|
*/
|
|
31149
31322
|
dataset?: string;
|
|
31323
|
+
/**
|
|
31324
|
+
* Destination address for the email.
|
|
31325
|
+
*/
|
|
31326
|
+
destinationAddress?: string;
|
|
31150
31327
|
/**
|
|
31151
31328
|
* The environment of the scriptName to bind to.
|
|
31152
31329
|
*/
|
|
@@ -31168,6 +31345,11 @@ export interface WorkerVersionBinding {
|
|
|
31168
31345
|
* JSON data to use.
|
|
31169
31346
|
*/
|
|
31170
31347
|
json?: string;
|
|
31348
|
+
/**
|
|
31349
|
+
* The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket.
|
|
31350
|
+
* Available values: "eu", "fedramp".
|
|
31351
|
+
*/
|
|
31352
|
+
jurisdiction?: string;
|
|
31171
31353
|
/**
|
|
31172
31354
|
* Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
|
|
31173
31355
|
*/
|
|
@@ -31188,10 +31370,18 @@ export interface WorkerVersionBinding {
|
|
|
31188
31370
|
* Namespace identifier tag.
|
|
31189
31371
|
*/
|
|
31190
31372
|
namespaceId: string;
|
|
31373
|
+
/**
|
|
31374
|
+
* The old name of the inherited binding. If set, the binding will be renamed from `oldName` to `name` in the new version. If not set, the binding will keep the same name between versions.
|
|
31375
|
+
*/
|
|
31376
|
+
oldName?: string;
|
|
31191
31377
|
/**
|
|
31192
31378
|
* Outbound worker.
|
|
31193
31379
|
*/
|
|
31194
31380
|
outbound?: outputs.WorkerVersionBindingOutbound;
|
|
31381
|
+
/**
|
|
31382
|
+
* The name of the file containing the data content. Only accepted for `service worker syntax` Workers.
|
|
31383
|
+
*/
|
|
31384
|
+
part?: string;
|
|
31195
31385
|
/**
|
|
31196
31386
|
* Name of the Pipeline to bind to.
|
|
31197
31387
|
*/
|
|
@@ -31222,13 +31412,17 @@ export interface WorkerVersionBinding {
|
|
|
31222
31412
|
text?: string;
|
|
31223
31413
|
/**
|
|
31224
31414
|
* The kind of resource that the binding provides.
|
|
31225
|
-
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "service", "tail*consumer", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow".
|
|
31415
|
+
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "data*blob", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "inherit", "images", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "send*email", "service", "tail*consumer", "text*blob", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow", "wasm*module".
|
|
31226
31416
|
*/
|
|
31227
31417
|
type: string;
|
|
31228
31418
|
/**
|
|
31229
31419
|
* Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
|
|
31230
31420
|
*/
|
|
31231
31421
|
usages?: string[];
|
|
31422
|
+
/**
|
|
31423
|
+
* Identifier for the version to inherit the binding from, which can be the version ID or the literal "latest" to inherit from the latest version. Defaults to inheriting the binding from the latest version.
|
|
31424
|
+
*/
|
|
31425
|
+
versionId?: string;
|
|
31232
31426
|
/**
|
|
31233
31427
|
* Name of the Workflow to bind to.
|
|
31234
31428
|
*/
|
|
@@ -31379,10 +31573,18 @@ export interface WorkersDeploymentVersion {
|
|
|
31379
31573
|
versionId: string;
|
|
31380
31574
|
}
|
|
31381
31575
|
export interface WorkersScriptAssets {
|
|
31576
|
+
/**
|
|
31577
|
+
* The SHA-256 hash of the asset manifest of files to upload.
|
|
31578
|
+
*/
|
|
31579
|
+
assetManifestSha256: string;
|
|
31382
31580
|
/**
|
|
31383
31581
|
* Configuration for assets within a Worker.
|
|
31384
31582
|
*/
|
|
31385
31583
|
config?: outputs.WorkersScriptAssetsConfig;
|
|
31584
|
+
/**
|
|
31585
|
+
* Path to the directory containing asset files to upload.
|
|
31586
|
+
*/
|
|
31587
|
+
directory?: string;
|
|
31386
31588
|
/**
|
|
31387
31589
|
* Token provided upon successful upload of all files from a registered manifest.
|
|
31388
31590
|
*/
|
|
@@ -31423,6 +31625,14 @@ export interface WorkersScriptBinding {
|
|
|
31423
31625
|
* Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
|
|
31424
31626
|
*/
|
|
31425
31627
|
algorithm?: string;
|
|
31628
|
+
/**
|
|
31629
|
+
* List of allowed destination addresses.
|
|
31630
|
+
*/
|
|
31631
|
+
allowedDestinationAddresses?: string[];
|
|
31632
|
+
/**
|
|
31633
|
+
* List of allowed sender addresses.
|
|
31634
|
+
*/
|
|
31635
|
+
allowedSenderAddresses?: string[];
|
|
31426
31636
|
/**
|
|
31427
31637
|
* R2 bucket to bind to.
|
|
31428
31638
|
*/
|
|
@@ -31439,6 +31649,10 @@ export interface WorkersScriptBinding {
|
|
|
31439
31649
|
* The name of the dataset to bind to.
|
|
31440
31650
|
*/
|
|
31441
31651
|
dataset?: string;
|
|
31652
|
+
/**
|
|
31653
|
+
* Destination address for the email.
|
|
31654
|
+
*/
|
|
31655
|
+
destinationAddress?: string;
|
|
31442
31656
|
/**
|
|
31443
31657
|
* The environment of the scriptName to bind to.
|
|
31444
31658
|
*/
|
|
@@ -31460,6 +31674,11 @@ export interface WorkersScriptBinding {
|
|
|
31460
31674
|
* JSON data to use.
|
|
31461
31675
|
*/
|
|
31462
31676
|
json?: string;
|
|
31677
|
+
/**
|
|
31678
|
+
* The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket.
|
|
31679
|
+
* Available values: "eu", "fedramp".
|
|
31680
|
+
*/
|
|
31681
|
+
jurisdiction?: string;
|
|
31463
31682
|
/**
|
|
31464
31683
|
* Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
|
|
31465
31684
|
*/
|
|
@@ -31480,10 +31699,18 @@ export interface WorkersScriptBinding {
|
|
|
31480
31699
|
* Namespace identifier tag.
|
|
31481
31700
|
*/
|
|
31482
31701
|
namespaceId: string;
|
|
31702
|
+
/**
|
|
31703
|
+
* The old name of the inherited binding. If set, the binding will be renamed from `oldName` to `name` in the new version. If not set, the binding will keep the same name between versions.
|
|
31704
|
+
*/
|
|
31705
|
+
oldName?: string;
|
|
31483
31706
|
/**
|
|
31484
31707
|
* Outbound worker.
|
|
31485
31708
|
*/
|
|
31486
31709
|
outbound?: outputs.WorkersScriptBindingOutbound;
|
|
31710
|
+
/**
|
|
31711
|
+
* The name of the file containing the data content. Only accepted for `service worker syntax` Workers.
|
|
31712
|
+
*/
|
|
31713
|
+
part?: string;
|
|
31487
31714
|
/**
|
|
31488
31715
|
* Name of the Pipeline to bind to.
|
|
31489
31716
|
*/
|
|
@@ -31514,13 +31741,17 @@ export interface WorkersScriptBinding {
|
|
|
31514
31741
|
text?: string;
|
|
31515
31742
|
/**
|
|
31516
31743
|
* The kind of resource that the binding provides.
|
|
31517
|
-
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "service", "tail*consumer", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow".
|
|
31744
|
+
* Available values: "ai", "analytics*engine", "assets", "browser", "d1", "data*blob", "dispatch*namespace", "durable*object*namespace", "hyperdrive", "inherit", "images", "json", "kv*namespace", "mtls*certificate", "plain*text", "pipelines", "queue", "r2*bucket", "secret*text", "send*email", "service", "tail*consumer", "text*blob", "vectorize", "version*metadata", "secrets*store*secret", "secret*key", "workflow", "wasm*module".
|
|
31518
31745
|
*/
|
|
31519
31746
|
type: string;
|
|
31520
31747
|
/**
|
|
31521
31748
|
* Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
|
|
31522
31749
|
*/
|
|
31523
31750
|
usages?: string[];
|
|
31751
|
+
/**
|
|
31752
|
+
* Identifier for the version to inherit the binding from, which can be the version ID or the literal "latest" to inherit from the latest version. Defaults to inheriting the binding from the latest version.
|
|
31753
|
+
*/
|
|
31754
|
+
versionId?: string;
|
|
31524
31755
|
/**
|
|
31525
31756
|
* Name of the Workflow to bind to.
|
|
31526
31757
|
*/
|
|
@@ -31577,6 +31808,10 @@ export interface WorkersScriptObservability {
|
|
|
31577
31808
|
logs?: outputs.WorkersScriptObservabilityLogs;
|
|
31578
31809
|
}
|
|
31579
31810
|
export interface WorkersScriptObservabilityLogs {
|
|
31811
|
+
/**
|
|
31812
|
+
* A list of destinations where logs will be exported to.
|
|
31813
|
+
*/
|
|
31814
|
+
destinations?: string[];
|
|
31580
31815
|
/**
|
|
31581
31816
|
* Whether logs are enabled for the Worker.
|
|
31582
31817
|
*/
|
|
@@ -31589,6 +31824,10 @@ export interface WorkersScriptObservabilityLogs {
|
|
|
31589
31824
|
* Whether [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs) are enabled for the Worker.
|
|
31590
31825
|
*/
|
|
31591
31826
|
invocationLogs: boolean;
|
|
31827
|
+
/**
|
|
31828
|
+
* Whether log persistence is enabled for the Worker.
|
|
31829
|
+
*/
|
|
31830
|
+
persist: boolean;
|
|
31592
31831
|
}
|
|
31593
31832
|
export interface WorkersScriptPlacement {
|
|
31594
31833
|
/**
|
|
@@ -31620,6 +31859,16 @@ export interface WorkersScriptTailConsumer {
|
|
|
31620
31859
|
*/
|
|
31621
31860
|
service: string;
|
|
31622
31861
|
}
|
|
31862
|
+
export interface WorkflowInstances {
|
|
31863
|
+
complete: number;
|
|
31864
|
+
errored: number;
|
|
31865
|
+
paused: number;
|
|
31866
|
+
queued: number;
|
|
31867
|
+
running: number;
|
|
31868
|
+
terminated: number;
|
|
31869
|
+
waiting: number;
|
|
31870
|
+
waitingForPause: number;
|
|
31871
|
+
}
|
|
31623
31872
|
export interface ZeroTrustAccessApplicationCorsHeaders {
|
|
31624
31873
|
/**
|
|
31625
31874
|
* Allows all HTTP request headers.
|
|
@@ -32434,7 +32683,6 @@ export interface ZeroTrustAccessApplicationSaasApp {
|
|
|
32434
32683
|
* The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
|
|
32435
32684
|
*/
|
|
32436
32685
|
consumerServiceUrl?: string;
|
|
32437
|
-
createdAt: string;
|
|
32438
32686
|
customAttributes?: outputs.ZeroTrustAccessApplicationSaasAppCustomAttribute[];
|
|
32439
32687
|
customClaims?: outputs.ZeroTrustAccessApplicationSaasAppCustomClaim[];
|
|
32440
32688
|
/**
|
|
@@ -32488,7 +32736,6 @@ export interface ZeroTrustAccessApplicationSaasApp {
|
|
|
32488
32736
|
* The endpoint where your SaaS application will send login requests.
|
|
32489
32737
|
*/
|
|
32490
32738
|
ssoEndpoint: string;
|
|
32491
|
-
updatedAt: string;
|
|
32492
32739
|
}
|
|
32493
32740
|
export interface ZeroTrustAccessApplicationSaasAppCustomAttribute {
|
|
32494
32741
|
/**
|
|
@@ -34555,11 +34802,11 @@ export interface ZeroTrustDexTestData {
|
|
|
34555
34802
|
/**
|
|
34556
34803
|
* The desired endpoint to test.
|
|
34557
34804
|
*/
|
|
34558
|
-
host
|
|
34805
|
+
host: string;
|
|
34559
34806
|
/**
|
|
34560
34807
|
* The type of test.
|
|
34561
34808
|
*/
|
|
34562
|
-
kind
|
|
34809
|
+
kind: string;
|
|
34563
34810
|
/**
|
|
34564
34811
|
* The HTTP request method type.
|
|
34565
34812
|
*/
|
|
@@ -34569,15 +34816,15 @@ export interface ZeroTrustDexTestTargetPolicy {
|
|
|
34569
34816
|
/**
|
|
34570
34817
|
* Whether the DEX rule is the account default
|
|
34571
34818
|
*/
|
|
34572
|
-
default
|
|
34819
|
+
default: boolean;
|
|
34573
34820
|
/**
|
|
34574
34821
|
* The id of the DEX rule
|
|
34575
34822
|
*/
|
|
34576
|
-
id
|
|
34823
|
+
id: string;
|
|
34577
34824
|
/**
|
|
34578
34825
|
* The name of the DEX rule
|
|
34579
34826
|
*/
|
|
34580
|
-
name
|
|
34827
|
+
name: string;
|
|
34581
34828
|
}
|
|
34582
34829
|
export interface ZeroTrustDlpCustomEntryConfidence {
|
|
34583
34830
|
/**
|
|
@@ -34823,299 +35070,310 @@ export interface ZeroTrustDnsLocationEndpoints {
|
|
|
34823
35070
|
}
|
|
34824
35071
|
export interface ZeroTrustDnsLocationEndpointsDoh {
|
|
34825
35072
|
/**
|
|
34826
|
-
*
|
|
35073
|
+
* Indicate whether the DOH endpoint is enabled for this location.
|
|
34827
35074
|
*/
|
|
34828
35075
|
enabled: boolean;
|
|
34829
35076
|
/**
|
|
34830
|
-
*
|
|
35077
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
34831
35078
|
*/
|
|
34832
35079
|
networks: outputs.ZeroTrustDnsLocationEndpointsDohNetwork[];
|
|
34833
35080
|
/**
|
|
34834
|
-
*
|
|
35081
|
+
* Specify whether the DOH endpoint requires user identity authentication.
|
|
34835
35082
|
*/
|
|
34836
35083
|
requireToken: boolean;
|
|
34837
35084
|
}
|
|
34838
35085
|
export interface ZeroTrustDnsLocationEndpointsDohNetwork {
|
|
34839
35086
|
/**
|
|
34840
|
-
*
|
|
35087
|
+
* Specify the IP address or IP CIDR.
|
|
34841
35088
|
*/
|
|
34842
35089
|
network: string;
|
|
34843
35090
|
}
|
|
34844
35091
|
export interface ZeroTrustDnsLocationEndpointsDot {
|
|
34845
35092
|
/**
|
|
34846
|
-
*
|
|
35093
|
+
* Indicate whether the DOT endpoint is enabled for this location.
|
|
34847
35094
|
*/
|
|
34848
35095
|
enabled: boolean;
|
|
34849
35096
|
/**
|
|
34850
|
-
*
|
|
35097
|
+
* Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
34851
35098
|
*/
|
|
34852
35099
|
networks: outputs.ZeroTrustDnsLocationEndpointsDotNetwork[];
|
|
34853
35100
|
}
|
|
34854
35101
|
export interface ZeroTrustDnsLocationEndpointsDotNetwork {
|
|
34855
35102
|
/**
|
|
34856
|
-
*
|
|
35103
|
+
* Specify the IP address or IP CIDR.
|
|
34857
35104
|
*/
|
|
34858
35105
|
network: string;
|
|
34859
35106
|
}
|
|
34860
35107
|
export interface ZeroTrustDnsLocationEndpointsIpv4 {
|
|
34861
35108
|
/**
|
|
34862
|
-
*
|
|
35109
|
+
* Indicate whether the IPv4 endpoint is enabled for this location.
|
|
34863
35110
|
*/
|
|
34864
35111
|
enabled: boolean;
|
|
34865
35112
|
}
|
|
34866
35113
|
export interface ZeroTrustDnsLocationEndpointsIpv6 {
|
|
34867
35114
|
/**
|
|
34868
|
-
*
|
|
35115
|
+
* Indicate whether the IPV6 endpoint is enabled for this location.
|
|
34869
35116
|
*/
|
|
34870
35117
|
enabled: boolean;
|
|
34871
35118
|
/**
|
|
34872
|
-
*
|
|
35119
|
+
* Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.
|
|
34873
35120
|
*/
|
|
34874
35121
|
networks: outputs.ZeroTrustDnsLocationEndpointsIpv6Network[];
|
|
34875
35122
|
}
|
|
34876
35123
|
export interface ZeroTrustDnsLocationEndpointsIpv6Network {
|
|
34877
35124
|
/**
|
|
34878
|
-
*
|
|
35125
|
+
* Specify the IPv6 address or IPv6 CIDR.
|
|
34879
35126
|
*/
|
|
34880
35127
|
network: string;
|
|
34881
35128
|
}
|
|
34882
35129
|
export interface ZeroTrustDnsLocationNetwork {
|
|
34883
35130
|
/**
|
|
34884
|
-
*
|
|
35131
|
+
* Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24.
|
|
34885
35132
|
*/
|
|
34886
35133
|
network: string;
|
|
34887
35134
|
}
|
|
34888
35135
|
export interface ZeroTrustGatewayLoggingSettingsByRuleType {
|
|
35136
|
+
/**
|
|
35137
|
+
* Configure logging settings for DNS firewall.
|
|
35138
|
+
*/
|
|
34889
35139
|
dns: outputs.ZeroTrustGatewayLoggingSettingsByRuleTypeDns;
|
|
35140
|
+
/**
|
|
35141
|
+
* Configure logging settings for HTTP/HTTPS firewall.
|
|
35142
|
+
*/
|
|
34890
35143
|
http: outputs.ZeroTrustGatewayLoggingSettingsByRuleTypeHttp;
|
|
35144
|
+
/**
|
|
35145
|
+
* Configure logging settings for Network firewall.
|
|
35146
|
+
*/
|
|
34891
35147
|
l4: outputs.ZeroTrustGatewayLoggingSettingsByRuleTypeL4;
|
|
34892
35148
|
}
|
|
34893
35149
|
export interface ZeroTrustGatewayLoggingSettingsByRuleTypeDns {
|
|
34894
35150
|
/**
|
|
34895
|
-
*
|
|
35151
|
+
* Specify whether to log all requests to this service.
|
|
34896
35152
|
*/
|
|
34897
35153
|
logAll: boolean;
|
|
34898
35154
|
/**
|
|
34899
|
-
*
|
|
35155
|
+
* Specify whether to log only blocking requests to this service.
|
|
34900
35156
|
*/
|
|
34901
35157
|
logBlocks: boolean;
|
|
34902
35158
|
}
|
|
34903
35159
|
export interface ZeroTrustGatewayLoggingSettingsByRuleTypeHttp {
|
|
34904
35160
|
/**
|
|
34905
|
-
*
|
|
35161
|
+
* Specify whether to log all requests to this service.
|
|
34906
35162
|
*/
|
|
34907
35163
|
logAll: boolean;
|
|
34908
35164
|
/**
|
|
34909
|
-
*
|
|
35165
|
+
* Specify whether to log only blocking requests to this service.
|
|
34910
35166
|
*/
|
|
34911
35167
|
logBlocks: boolean;
|
|
34912
35168
|
}
|
|
34913
35169
|
export interface ZeroTrustGatewayLoggingSettingsByRuleTypeL4 {
|
|
34914
35170
|
/**
|
|
34915
|
-
*
|
|
35171
|
+
* Specify whether to log all requests to this service.
|
|
34916
35172
|
*/
|
|
34917
35173
|
logAll: boolean;
|
|
34918
35174
|
/**
|
|
34919
|
-
*
|
|
35175
|
+
* Specify whether to log only blocking requests to this service.
|
|
34920
35176
|
*/
|
|
34921
35177
|
logBlocks: boolean;
|
|
34922
35178
|
}
|
|
34923
35179
|
export interface ZeroTrustGatewayPolicyExpiration {
|
|
34924
35180
|
/**
|
|
34925
|
-
*
|
|
35181
|
+
* Defines the default duration a policy active in minutes. Must set in order to use the `resetExpiration` endpoint on this rule.
|
|
34926
35182
|
*/
|
|
34927
35183
|
duration?: number;
|
|
34928
35184
|
/**
|
|
34929
|
-
*
|
|
35185
|
+
* Indicates whether the policy is expired.
|
|
34930
35186
|
*/
|
|
34931
35187
|
expired: boolean;
|
|
34932
35188
|
/**
|
|
34933
|
-
*
|
|
34934
|
-
* applied.
|
|
35189
|
+
* Show the timestamp when the policy expires and stops applying. The value must follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets but converts them to the equivalent UTC+00:00 value and returns timestamps with a trailing Z. Expiration policies ignore client timezones and expire globally at the specified expiresAt time.
|
|
34935
35190
|
*/
|
|
34936
35191
|
expiresAt: string;
|
|
34937
35192
|
}
|
|
34938
35193
|
export interface ZeroTrustGatewayPolicyRuleSettings {
|
|
34939
35194
|
/**
|
|
34940
|
-
* Add custom headers to allowed requests
|
|
35195
|
+
* Add custom headers to allowed requests as key-value pairs. Use header names as keys that map to arrays of header values. Settable only for `http` rules with the action set to `allow`.
|
|
34941
35196
|
*/
|
|
34942
35197
|
addHeaders?: {
|
|
34943
35198
|
[key: string]: string[];
|
|
34944
35199
|
};
|
|
34945
35200
|
/**
|
|
34946
|
-
* Set
|
|
35201
|
+
* Set to enable MSP children to bypass this rule. Only parent MSP accounts can set this. this rule. Settable for all types of rules.
|
|
34947
35202
|
*/
|
|
34948
35203
|
allowChildBypass: boolean;
|
|
34949
35204
|
/**
|
|
34950
|
-
*
|
|
35205
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with `auditSsh` action.
|
|
34951
35206
|
*/
|
|
34952
35207
|
auditSsh?: outputs.ZeroTrustGatewayPolicyRuleSettingsAuditSsh;
|
|
34953
35208
|
/**
|
|
34954
|
-
* Configure
|
|
35209
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the action set to `isolate`.
|
|
34955
35210
|
*/
|
|
34956
35211
|
bisoAdminControls?: outputs.ZeroTrustGatewayPolicyRuleSettingsBisoAdminControls;
|
|
34957
35212
|
/**
|
|
34958
|
-
*
|
|
35213
|
+
* Configure custom block page settings. If missing or null, use the account settings. Settable only for `http` rules with the action set to `block`.
|
|
34959
35214
|
*/
|
|
34960
35215
|
blockPage?: outputs.ZeroTrustGatewayPolicyRuleSettingsBlockPage;
|
|
34961
35216
|
/**
|
|
34962
|
-
* Enable the custom block page.
|
|
35217
|
+
* Enable the custom block page. Settable only for `dns` rules with action `block`.
|
|
34963
35218
|
*/
|
|
34964
35219
|
blockPageEnabled: boolean;
|
|
34965
35220
|
/**
|
|
34966
|
-
*
|
|
35221
|
+
* Explain why the rule blocks the request. The custom block page shows this text (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action set to `block`.
|
|
34967
35222
|
*/
|
|
34968
35223
|
blockReason: string;
|
|
34969
35224
|
/**
|
|
34970
|
-
* Set
|
|
35225
|
+
* Set to enable MSP accounts to bypass their parent's rules. Only MSP child accounts can set this. Settable for all types of rules.
|
|
34971
35226
|
*/
|
|
34972
35227
|
bypassParentRule?: boolean;
|
|
34973
35228
|
/**
|
|
34974
|
-
* Configure
|
|
35229
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with the action set to `allow`.
|
|
34975
35230
|
*/
|
|
34976
35231
|
checkSession?: outputs.ZeroTrustGatewayPolicyRuleSettingsCheckSession;
|
|
34977
35232
|
/**
|
|
34978
|
-
*
|
|
35233
|
+
* Configure custom resolvers to route queries that match the resolver policy. Unused with 'resolve*dns*through*cloudflare' or 'resolve*dns*internally' settings. DNS queries get routed to the address closest to their origin. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
34979
35234
|
*/
|
|
34980
35235
|
dnsResolvers?: outputs.ZeroTrustGatewayPolicyRuleSettingsDnsResolvers;
|
|
34981
35236
|
/**
|
|
34982
|
-
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.
|
|
35237
|
+
* Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs. Settable only for `egress` rules.
|
|
34983
35238
|
*/
|
|
34984
35239
|
egress?: outputs.ZeroTrustGatewayPolicyRuleSettingsEgress;
|
|
34985
35240
|
/**
|
|
34986
|
-
*
|
|
35241
|
+
* Ignore category matches at CNAME domains in a response. When off, evaluate categories in this rule against all CNAME domain categories in the response. Settable only for `dns` and `dnsResolver` rules.
|
|
34987
35242
|
*/
|
|
34988
35243
|
ignoreCnameCategoryMatches: boolean;
|
|
34989
35244
|
/**
|
|
34990
|
-
*
|
|
35245
|
+
* Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE]. Settable only for `dns` rules.
|
|
34991
35246
|
*/
|
|
34992
35247
|
insecureDisableDnssecValidation: boolean;
|
|
34993
35248
|
/**
|
|
34994
|
-
*
|
|
35249
|
+
* Enable IPs in DNS resolver category blocks. The system blocks only domain name categories unless you enable this setting. Settable only for `dns` and `dnsResolver` rules.
|
|
34995
35250
|
*/
|
|
34996
35251
|
ipCategories: boolean;
|
|
34997
35252
|
/**
|
|
34998
|
-
*
|
|
35253
|
+
* Indicates whether to include IPs in DNS resolver indicator feed blocks. Default, indicator feeds block only domain names. Settable only for `dns` and `dnsResolver` rules.
|
|
34999
35254
|
*/
|
|
35000
35255
|
ipIndicatorFeeds: boolean;
|
|
35001
35256
|
/**
|
|
35002
|
-
* Send matching traffic to the supplied destination IP address
|
|
35257
|
+
* Send matching traffic to the supplied destination IP address and port. Settable only for `l4` rules with the action set to `l4Override`.
|
|
35003
35258
|
*/
|
|
35004
35259
|
l4override?: outputs.ZeroTrustGatewayPolicyRuleSettingsL4override;
|
|
35005
35260
|
/**
|
|
35006
|
-
* Configure a notification to display on the user's device when this rule
|
|
35261
|
+
* Configure a notification to display on the user's device when this rule matched. Settable for all types of rules with the action set to `block`.
|
|
35007
35262
|
*/
|
|
35008
35263
|
notificationSettings?: outputs.ZeroTrustGatewayPolicyRuleSettingsNotificationSettings;
|
|
35009
35264
|
/**
|
|
35010
|
-
*
|
|
35265
|
+
* Defines a hostname for override, for the matching DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
35011
35266
|
*/
|
|
35012
35267
|
overrideHost: string;
|
|
35013
35268
|
/**
|
|
35014
|
-
*
|
|
35269
|
+
* Defines a an IP or set of IPs for overriding matched DNS queries. Settable only for `dns` rules with the action set to `override`.
|
|
35015
35270
|
*/
|
|
35016
35271
|
overrideIps: string[];
|
|
35017
35272
|
/**
|
|
35018
|
-
* Configure DLP payload logging.
|
|
35273
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
35019
35274
|
*/
|
|
35020
35275
|
payloadLog?: outputs.ZeroTrustGatewayPolicyRuleSettingsPayloadLog;
|
|
35021
35276
|
/**
|
|
35022
|
-
*
|
|
35277
|
+
* Configure settings that apply to quarantine rules. Settable only for `http` rules.
|
|
35023
35278
|
*/
|
|
35024
35279
|
quarantine?: outputs.ZeroTrustGatewayPolicyRuleSettingsQuarantine;
|
|
35025
35280
|
/**
|
|
35026
|
-
*
|
|
35281
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action set to `redirect`.
|
|
35027
35282
|
*/
|
|
35028
35283
|
redirect?: outputs.ZeroTrustGatewayPolicyRuleSettingsRedirect;
|
|
35029
35284
|
/**
|
|
35030
|
-
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input.
|
|
35285
|
+
* Configure to forward the query to the internal DNS service, passing the specified 'view*id' as input. Not used when 'dns*resolvers' is specified or 'resolve*dns*through*cloudflare' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
35031
35286
|
*/
|
|
35032
35287
|
resolveDnsInternally?: outputs.ZeroTrustGatewayPolicyRuleSettingsResolveDnsInternally;
|
|
35033
35288
|
/**
|
|
35034
|
-
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot
|
|
35289
|
+
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot set when 'dns*resolvers' specified or 'resolve*dns_internally' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dnsResolver` rules.
|
|
35035
35290
|
*/
|
|
35036
35291
|
resolveDnsThroughCloudflare: boolean;
|
|
35037
35292
|
/**
|
|
35038
|
-
* Configure behavior when an upstream
|
|
35293
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error occurs. Settable only for `http` rules with the action set to `allow`.
|
|
35039
35294
|
*/
|
|
35040
35295
|
untrustedCert?: outputs.ZeroTrustGatewayPolicyRuleSettingsUntrustedCert;
|
|
35041
35296
|
}
|
|
35042
35297
|
export interface ZeroTrustGatewayPolicyRuleSettingsAuditSsh {
|
|
35043
35298
|
/**
|
|
35044
|
-
* Enable
|
|
35299
|
+
* Enable SSH command logging.
|
|
35045
35300
|
*/
|
|
35046
35301
|
commandLogging?: boolean;
|
|
35047
35302
|
}
|
|
35048
35303
|
export interface ZeroTrustGatewayPolicyRuleSettingsBisoAdminControls {
|
|
35049
35304
|
/**
|
|
35050
|
-
* Configure
|
|
35305
|
+
* Configure copy behavior. If set to remote*only, users cannot copy isolated content from the remote browser to the local clipboard. If this field is absent, copying remains enabled. Applies only when version == "v2".
|
|
35051
35306
|
* Available values: "enabled", "disabled", "remote*only".
|
|
35052
35307
|
*/
|
|
35053
35308
|
copy?: string;
|
|
35054
35309
|
/**
|
|
35055
35310
|
* Set to false to enable copy-pasting. Only applies when `version == "v1"`.
|
|
35056
35311
|
*/
|
|
35057
|
-
dcp
|
|
35312
|
+
dcp?: boolean;
|
|
35058
35313
|
/**
|
|
35059
35314
|
* Set to false to enable downloading. Only applies when `version == "v1"`.
|
|
35060
35315
|
*/
|
|
35061
|
-
dd
|
|
35316
|
+
dd?: boolean;
|
|
35062
35317
|
/**
|
|
35063
35318
|
* Set to false to enable keyboard usage. Only applies when `version == "v1"`.
|
|
35064
35319
|
*/
|
|
35065
|
-
dk
|
|
35320
|
+
dk?: boolean;
|
|
35066
35321
|
/**
|
|
35067
|
-
* Configure
|
|
35322
|
+
* Configure download behavior. When set to remote*only, users can view downloads but cannot save them. Applies only when version == "v2".
|
|
35068
35323
|
* Available values: "enabled", "disabled", "remote*only".
|
|
35069
35324
|
*/
|
|
35070
35325
|
download?: string;
|
|
35071
35326
|
/**
|
|
35072
35327
|
* Set to false to enable printing. Only applies when `version == "v1"`.
|
|
35073
35328
|
*/
|
|
35074
|
-
dp
|
|
35329
|
+
dp?: boolean;
|
|
35075
35330
|
/**
|
|
35076
35331
|
* Set to false to enable uploading. Only applies when `version == "v1"`.
|
|
35077
35332
|
*/
|
|
35078
|
-
du
|
|
35333
|
+
du?: boolean;
|
|
35079
35334
|
/**
|
|
35080
|
-
* Configure
|
|
35335
|
+
* Configure keyboard usage behavior. If this field is absent, keyboard usage remains enabled. Applies only when version == "v2".
|
|
35081
35336
|
* Available values: "enabled", "disabled".
|
|
35082
35337
|
*/
|
|
35083
35338
|
keyboard?: string;
|
|
35084
35339
|
/**
|
|
35085
|
-
* Configure
|
|
35340
|
+
* Configure paste behavior. If set to remote*only, users cannot paste content from the local clipboard into isolated pages. If this field is absent, pasting remains enabled. Applies only when version == "v2".
|
|
35086
35341
|
* Available values: "enabled", "disabled", "remote*only".
|
|
35087
35342
|
*/
|
|
35088
35343
|
paste?: string;
|
|
35089
35344
|
/**
|
|
35090
|
-
* Configure
|
|
35345
|
+
* Configure print behavior. Default, Printing is enabled. Applies only when version == "v2".
|
|
35091
35346
|
* Available values: "enabled", "disabled".
|
|
35092
35347
|
*/
|
|
35093
35348
|
printing?: string;
|
|
35094
35349
|
/**
|
|
35095
|
-
* Configure
|
|
35350
|
+
* Configure upload behavior. If this field is absent, uploading remains enabled. Applies only when version == "v2".
|
|
35096
35351
|
* Available values: "enabled", "disabled".
|
|
35097
35352
|
*/
|
|
35098
35353
|
upload?: string;
|
|
35099
35354
|
/**
|
|
35100
|
-
*
|
|
35355
|
+
* Indicate which version of the browser isolation controls should apply.
|
|
35101
35356
|
* Available values: "v1", "v2".
|
|
35102
35357
|
*/
|
|
35103
35358
|
version: string;
|
|
35104
35359
|
}
|
|
35105
35360
|
export interface ZeroTrustGatewayPolicyRuleSettingsBlockPage {
|
|
35106
35361
|
/**
|
|
35107
|
-
*
|
|
35362
|
+
* Specify whether to pass the context information as query parameters.
|
|
35108
35363
|
*/
|
|
35109
35364
|
includeContext?: boolean;
|
|
35110
35365
|
/**
|
|
35111
|
-
* URI to which the user
|
|
35366
|
+
* Specify the URI to which the user is redirected.
|
|
35112
35367
|
*/
|
|
35113
35368
|
targetUri: string;
|
|
35114
35369
|
}
|
|
35115
35370
|
export interface ZeroTrustGatewayPolicyRuleSettingsCheckSession {
|
|
35371
|
+
/**
|
|
35372
|
+
* Sets the required session freshness threshold. The API returns a normalized version of this value.
|
|
35373
|
+
*/
|
|
35116
35374
|
duration?: string;
|
|
35117
35375
|
/**
|
|
35118
|
-
*
|
|
35376
|
+
* Enable session enforcement.
|
|
35119
35377
|
*/
|
|
35120
35378
|
enforce?: boolean;
|
|
35121
35379
|
}
|
|
@@ -35125,71 +35383,71 @@ export interface ZeroTrustGatewayPolicyRuleSettingsDnsResolvers {
|
|
|
35125
35383
|
}
|
|
35126
35384
|
export interface ZeroTrustGatewayPolicyRuleSettingsDnsResolversIpv4 {
|
|
35127
35385
|
/**
|
|
35128
|
-
* IPv4 address of upstream resolver.
|
|
35386
|
+
* Specify the IPv4 address of the upstream resolver.
|
|
35129
35387
|
*/
|
|
35130
35388
|
ip: string;
|
|
35131
35389
|
/**
|
|
35132
|
-
*
|
|
35390
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
35133
35391
|
*/
|
|
35134
35392
|
port?: number;
|
|
35135
35393
|
/**
|
|
35136
|
-
*
|
|
35394
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
35137
35395
|
*/
|
|
35138
35396
|
routeThroughPrivateNetwork?: boolean;
|
|
35139
35397
|
/**
|
|
35140
|
-
*
|
|
35398
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
35141
35399
|
*/
|
|
35142
35400
|
vnetId?: string;
|
|
35143
35401
|
}
|
|
35144
35402
|
export interface ZeroTrustGatewayPolicyRuleSettingsDnsResolversIpv6 {
|
|
35145
35403
|
/**
|
|
35146
|
-
* IPv6 address of upstream resolver.
|
|
35404
|
+
* Specify the IPv6 address of the upstream resolver.
|
|
35147
35405
|
*/
|
|
35148
35406
|
ip: string;
|
|
35149
35407
|
/**
|
|
35150
|
-
*
|
|
35408
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.
|
|
35151
35409
|
*/
|
|
35152
35410
|
port?: number;
|
|
35153
35411
|
/**
|
|
35154
|
-
*
|
|
35412
|
+
* Indicate whether to connect to this resolver over a private network. Must set when vnetId set.
|
|
35155
35413
|
*/
|
|
35156
35414
|
routeThroughPrivateNetwork?: boolean;
|
|
35157
35415
|
/**
|
|
35158
|
-
*
|
|
35416
|
+
* Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.
|
|
35159
35417
|
*/
|
|
35160
35418
|
vnetId?: string;
|
|
35161
35419
|
}
|
|
35162
35420
|
export interface ZeroTrustGatewayPolicyRuleSettingsEgress {
|
|
35163
35421
|
/**
|
|
35164
|
-
*
|
|
35422
|
+
* Specify the IPv4 address to use for egress.
|
|
35165
35423
|
*/
|
|
35166
35424
|
ipv4?: string;
|
|
35167
35425
|
/**
|
|
35168
|
-
*
|
|
35426
|
+
* Specify the fallback IPv4 address to use for egress when the primary IPv4 fails. Set '0.0.0.0' to indicate local egress via WARP IPs.
|
|
35169
35427
|
*/
|
|
35170
35428
|
ipv4Fallback?: string;
|
|
35171
35429
|
/**
|
|
35172
|
-
*
|
|
35430
|
+
* Specify the IPv6 range to use for egress.
|
|
35173
35431
|
*/
|
|
35174
35432
|
ipv6?: string;
|
|
35175
35433
|
}
|
|
35176
35434
|
export interface ZeroTrustGatewayPolicyRuleSettingsL4override {
|
|
35177
35435
|
/**
|
|
35178
|
-
* IPv4 or IPv6 address.
|
|
35436
|
+
* Defines the IPv4 or IPv6 address.
|
|
35179
35437
|
*/
|
|
35180
35438
|
ip?: string;
|
|
35181
35439
|
/**
|
|
35182
|
-
*
|
|
35440
|
+
* Defines a port number to use for TCP/UDP overrides.
|
|
35183
35441
|
*/
|
|
35184
35442
|
port?: number;
|
|
35185
35443
|
}
|
|
35186
35444
|
export interface ZeroTrustGatewayPolicyRuleSettingsNotificationSettings {
|
|
35187
35445
|
/**
|
|
35188
|
-
*
|
|
35446
|
+
* Enable notification.
|
|
35189
35447
|
*/
|
|
35190
35448
|
enabled?: boolean;
|
|
35191
35449
|
/**
|
|
35192
|
-
*
|
|
35450
|
+
* Indicates whether to pass the context information as query parameters.
|
|
35193
35451
|
*/
|
|
35194
35452
|
includeContext?: boolean;
|
|
35195
35453
|
/**
|
|
@@ -35197,360 +35455,337 @@ export interface ZeroTrustGatewayPolicyRuleSettingsNotificationSettings {
|
|
|
35197
35455
|
*/
|
|
35198
35456
|
msg?: string;
|
|
35199
35457
|
/**
|
|
35200
|
-
*
|
|
35458
|
+
* Defines an optional URL to direct users to additional information. If unset, the notification opens a block page.
|
|
35201
35459
|
*/
|
|
35202
35460
|
supportUrl?: string;
|
|
35203
35461
|
}
|
|
35204
35462
|
export interface ZeroTrustGatewayPolicyRuleSettingsPayloadLog {
|
|
35205
35463
|
/**
|
|
35206
|
-
*
|
|
35464
|
+
* Enable DLP payload logging for this rule.
|
|
35207
35465
|
*/
|
|
35208
35466
|
enabled?: boolean;
|
|
35209
35467
|
}
|
|
35210
35468
|
export interface ZeroTrustGatewayPolicyRuleSettingsQuarantine {
|
|
35211
35469
|
/**
|
|
35212
|
-
*
|
|
35470
|
+
* Specify the types of files to sandbox.
|
|
35213
35471
|
*/
|
|
35214
35472
|
fileTypes?: string[];
|
|
35215
35473
|
}
|
|
35216
35474
|
export interface ZeroTrustGatewayPolicyRuleSettingsRedirect {
|
|
35217
35475
|
/**
|
|
35218
|
-
*
|
|
35476
|
+
* Specify whether to pass the context information as query parameters.
|
|
35219
35477
|
*/
|
|
35220
35478
|
includeContext?: boolean;
|
|
35221
35479
|
/**
|
|
35222
|
-
*
|
|
35480
|
+
* Specify whether to append the path and query parameters from the original request to target_uri.
|
|
35223
35481
|
*/
|
|
35224
35482
|
preservePathAndQuery?: boolean;
|
|
35225
35483
|
/**
|
|
35226
|
-
* URI to which the user
|
|
35484
|
+
* Specify the URI to which the user is redirected.
|
|
35227
35485
|
*/
|
|
35228
35486
|
targetUri: string;
|
|
35229
35487
|
}
|
|
35230
35488
|
export interface ZeroTrustGatewayPolicyRuleSettingsResolveDnsInternally {
|
|
35231
35489
|
/**
|
|
35232
|
-
*
|
|
35490
|
+
* Specify the fallback behavior to apply when the internal DNS response code differs from 'NOERROR' or when the response data contains only CNAME records for 'A' or 'AAAA' queries.
|
|
35233
35491
|
* Available values: "none", "publicDns".
|
|
35234
35492
|
*/
|
|
35235
35493
|
fallback?: string;
|
|
35236
35494
|
/**
|
|
35237
|
-
*
|
|
35495
|
+
* Specify the internal DNS view identifier to pass to the internal DNS service.
|
|
35238
35496
|
*/
|
|
35239
35497
|
viewId?: string;
|
|
35240
35498
|
}
|
|
35241
35499
|
export interface ZeroTrustGatewayPolicyRuleSettingsUntrustedCert {
|
|
35242
35500
|
/**
|
|
35243
|
-
*
|
|
35501
|
+
* Defines the action performed when an untrusted certificate seen. The default action an error with HTTP code 526.
|
|
35244
35502
|
* Available values: "passThrough", "block", "error".
|
|
35245
35503
|
*/
|
|
35246
35504
|
action?: string;
|
|
35247
35505
|
}
|
|
35248
35506
|
export interface ZeroTrustGatewayPolicySchedule {
|
|
35249
|
-
/**
|
|
35250
|
-
* The time intervals when the rule will be active on Fridays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Fridays.
|
|
35251
|
-
*/
|
|
35252
35507
|
fri?: string;
|
|
35253
|
-
/**
|
|
35254
|
-
* The time intervals when the rule will be active on Mondays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Mondays.
|
|
35255
|
-
*/
|
|
35256
35508
|
mon?: string;
|
|
35257
|
-
/**
|
|
35258
|
-
* The time intervals when the rule will be active on Saturdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Saturdays.
|
|
35259
|
-
*/
|
|
35260
35509
|
sat?: string;
|
|
35261
|
-
/**
|
|
35262
|
-
* The time intervals when the rule will be active on Sundays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Sundays.
|
|
35263
|
-
*/
|
|
35264
35510
|
sun?: string;
|
|
35265
|
-
/**
|
|
35266
|
-
* The time intervals when the rule will be active on Thursdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Thursdays.
|
|
35267
|
-
*/
|
|
35268
35511
|
thu?: string;
|
|
35269
35512
|
/**
|
|
35270
|
-
*
|
|
35513
|
+
* Specify the time zone for rule evaluation. When a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway always uses the current time for that time zone. When this parameter is omitted, Gateway uses the time zone determined from the user's IP address. Colo time zone is used when the user's IP address does not resolve to a location.
|
|
35271
35514
|
*/
|
|
35272
35515
|
timeZone?: string;
|
|
35273
|
-
/**
|
|
35274
|
-
* The time intervals when the rule will be active on Tuesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Tuesdays.
|
|
35275
|
-
*/
|
|
35276
35516
|
tue?: string;
|
|
35277
|
-
/**
|
|
35278
|
-
* The time intervals when the rule will be active on Wednesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Wednesdays.
|
|
35279
|
-
*/
|
|
35280
35517
|
wed?: string;
|
|
35281
35518
|
}
|
|
35282
35519
|
export interface ZeroTrustGatewaySettingsSettings {
|
|
35283
35520
|
/**
|
|
35284
|
-
*
|
|
35521
|
+
* Specify activity log settings.
|
|
35285
35522
|
*/
|
|
35286
35523
|
activityLog?: outputs.ZeroTrustGatewaySettingsSettingsActivityLog;
|
|
35287
35524
|
/**
|
|
35288
|
-
*
|
|
35525
|
+
* Specify anti-virus settings.
|
|
35289
35526
|
*/
|
|
35290
35527
|
antivirus?: outputs.ZeroTrustGatewaySettingsSettingsAntivirus;
|
|
35291
35528
|
/**
|
|
35292
|
-
*
|
|
35529
|
+
* Specify block page layout settings.
|
|
35293
35530
|
*/
|
|
35294
35531
|
blockPage?: outputs.ZeroTrustGatewaySettingsSettingsBlockPage;
|
|
35295
35532
|
/**
|
|
35296
|
-
* DLP
|
|
35533
|
+
* Specify the DLP inspection mode.
|
|
35297
35534
|
*/
|
|
35298
35535
|
bodyScanning?: outputs.ZeroTrustGatewaySettingsSettingsBodyScanning;
|
|
35299
35536
|
/**
|
|
35300
|
-
* Browser
|
|
35537
|
+
* Specify Clientless Browser Isolation settings.
|
|
35301
35538
|
*/
|
|
35302
35539
|
browserIsolation?: outputs.ZeroTrustGatewaySettingsSettingsBrowserIsolation;
|
|
35303
35540
|
/**
|
|
35304
|
-
*
|
|
35541
|
+
* Specify certificate settings for Gateway TLS interception. If unset, the Cloudflare Root CA handles interception.
|
|
35305
35542
|
*/
|
|
35306
35543
|
certificate?: outputs.ZeroTrustGatewaySettingsSettingsCertificate;
|
|
35307
35544
|
/**
|
|
35308
|
-
*
|
|
35545
|
+
* Specify custom certificate settings for BYO-PKI. This field is deprecated; use `certificate` instead.
|
|
35309
35546
|
*
|
|
35310
35547
|
* @deprecated This attribute is deprecated.
|
|
35311
35548
|
*/
|
|
35312
35549
|
customCertificate?: outputs.ZeroTrustGatewaySettingsSettingsCustomCertificate;
|
|
35313
35550
|
/**
|
|
35314
|
-
*
|
|
35551
|
+
* Specify user email settings for the firewall policies. When this is enabled, we standardize the email addresses in the identity part of the rule, so that they match the extended email variants in the firewall policies. When this setting is turned off, the email addresses in the identity part of the rule will be matched exactly as provided. If your email has `.` or `+` modifiers, you should enable this setting.
|
|
35315
35552
|
*/
|
|
35316
35553
|
extendedEmailMatching?: outputs.ZeroTrustGatewaySettingsSettingsExtendedEmailMatching;
|
|
35317
35554
|
/**
|
|
35318
|
-
* FIPS settings.
|
|
35555
|
+
* Specify FIPS settings.
|
|
35319
35556
|
*/
|
|
35320
35557
|
fips?: outputs.ZeroTrustGatewaySettingsSettingsFips;
|
|
35321
35558
|
/**
|
|
35322
|
-
*
|
|
35559
|
+
* Enable host selection in egress policies.
|
|
35323
35560
|
*/
|
|
35324
35561
|
hostSelector?: outputs.ZeroTrustGatewaySettingsSettingsHostSelector;
|
|
35325
35562
|
/**
|
|
35326
|
-
*
|
|
35563
|
+
* Define the proxy inspection mode.
|
|
35327
35564
|
*/
|
|
35328
35565
|
inspection?: outputs.ZeroTrustGatewaySettingsSettingsInspection;
|
|
35329
35566
|
/**
|
|
35330
|
-
*
|
|
35567
|
+
* Specify whether to detect protocols from the initial bytes of client traffic.
|
|
35331
35568
|
*/
|
|
35332
35569
|
protocolDetection?: outputs.ZeroTrustGatewaySettingsSettingsProtocolDetection;
|
|
35333
35570
|
/**
|
|
35334
|
-
*
|
|
35571
|
+
* Specify whether to enable the sandbox.
|
|
35335
35572
|
*/
|
|
35336
35573
|
sandbox?: outputs.ZeroTrustGatewaySettingsSettingsSandbox;
|
|
35337
35574
|
/**
|
|
35338
|
-
*
|
|
35575
|
+
* Specify whether to inspect encrypted HTTP traffic.
|
|
35339
35576
|
*/
|
|
35340
35577
|
tlsDecrypt?: outputs.ZeroTrustGatewaySettingsSettingsTlsDecrypt;
|
|
35341
35578
|
}
|
|
35342
35579
|
export interface ZeroTrustGatewaySettingsSettingsActivityLog {
|
|
35343
35580
|
/**
|
|
35344
|
-
*
|
|
35581
|
+
* Specify whether to log activity.
|
|
35345
35582
|
*/
|
|
35346
35583
|
enabled?: boolean;
|
|
35347
35584
|
}
|
|
35348
35585
|
export interface ZeroTrustGatewaySettingsSettingsAntivirus {
|
|
35349
35586
|
/**
|
|
35350
|
-
*
|
|
35587
|
+
* Specify whether to enable anti-virus scanning on downloads.
|
|
35351
35588
|
*/
|
|
35352
35589
|
enabledDownloadPhase: boolean;
|
|
35353
35590
|
/**
|
|
35354
|
-
*
|
|
35591
|
+
* Specify whether to enable anti-virus scanning on uploads.
|
|
35355
35592
|
*/
|
|
35356
35593
|
enabledUploadPhase: boolean;
|
|
35357
35594
|
/**
|
|
35358
|
-
*
|
|
35595
|
+
* Specify whether to block requests for unscannable files.
|
|
35359
35596
|
*/
|
|
35360
35597
|
failClosed: boolean;
|
|
35361
35598
|
/**
|
|
35362
|
-
* Configure
|
|
35599
|
+
* Configure the message the user's device shows during an antivirus scan.
|
|
35363
35600
|
*/
|
|
35364
35601
|
notificationSettings: outputs.ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings;
|
|
35365
35602
|
}
|
|
35366
35603
|
export interface ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings {
|
|
35367
35604
|
/**
|
|
35368
|
-
*
|
|
35605
|
+
* Specify whether to enable notifications.
|
|
35369
35606
|
*/
|
|
35370
35607
|
enabled?: boolean;
|
|
35371
35608
|
/**
|
|
35372
|
-
*
|
|
35609
|
+
* Specify whether to include context information as query parameters.
|
|
35373
35610
|
*/
|
|
35374
35611
|
includeContext?: boolean;
|
|
35375
35612
|
/**
|
|
35376
|
-
*
|
|
35613
|
+
* Specify the message to show in the notification.
|
|
35377
35614
|
*/
|
|
35378
35615
|
msg?: string;
|
|
35379
35616
|
/**
|
|
35380
|
-
*
|
|
35617
|
+
* Specify a URL that directs users to more information. If unset, the notification opens a block page.
|
|
35381
35618
|
*/
|
|
35382
35619
|
supportUrl?: string;
|
|
35383
35620
|
}
|
|
35384
35621
|
export interface ZeroTrustGatewaySettingsSettingsBlockPage {
|
|
35385
35622
|
/**
|
|
35386
|
-
*
|
|
35623
|
+
* Specify the block page background color in `#rrggbb` format when the mode is customized*block*page.
|
|
35387
35624
|
*/
|
|
35388
35625
|
backgroundColor?: string;
|
|
35389
35626
|
/**
|
|
35390
|
-
*
|
|
35627
|
+
* Specify whether to enable the custom block page.
|
|
35391
35628
|
*/
|
|
35392
35629
|
enabled?: boolean;
|
|
35393
35630
|
/**
|
|
35394
|
-
*
|
|
35631
|
+
* Specify the block page footer text when the mode is customized*block*page.
|
|
35395
35632
|
*/
|
|
35396
35633
|
footerText?: string;
|
|
35397
35634
|
/**
|
|
35398
|
-
*
|
|
35635
|
+
* Specify the block page header text when the mode is customized*block*page.
|
|
35399
35636
|
*/
|
|
35400
35637
|
headerText?: string;
|
|
35401
35638
|
/**
|
|
35402
|
-
*
|
|
35639
|
+
* Specify whether to append context to target*uri as query parameters. This applies only when the mode is redirect*uri.
|
|
35403
35640
|
*/
|
|
35404
35641
|
includeContext?: boolean;
|
|
35405
35642
|
/**
|
|
35406
|
-
*
|
|
35643
|
+
* Specify the full URL to the logo file when the mode is customized*block*page.
|
|
35407
35644
|
*/
|
|
35408
35645
|
logoPath?: string;
|
|
35409
35646
|
/**
|
|
35410
|
-
*
|
|
35647
|
+
* Specify the admin email for users to contact when the mode is customized*block*page.
|
|
35411
35648
|
*/
|
|
35412
35649
|
mailtoAddress?: string;
|
|
35413
35650
|
/**
|
|
35414
|
-
*
|
|
35651
|
+
* Specify the subject line for emails created from the block page when the mode is customized*block*page.
|
|
35415
35652
|
*/
|
|
35416
35653
|
mailtoSubject?: string;
|
|
35417
35654
|
/**
|
|
35418
|
-
*
|
|
35419
|
-
* Available values: "", "
|
|
35655
|
+
* Specify whether to redirect users to a Cloudflare-hosted block page or a customer-provided URI.
|
|
35656
|
+
* Available values: "", "customized*block*page", "redirectUri".
|
|
35420
35657
|
*/
|
|
35421
35658
|
mode?: string;
|
|
35422
35659
|
/**
|
|
35423
|
-
*
|
|
35660
|
+
* Specify the block page title when the mode is customized*block*page.
|
|
35424
35661
|
*/
|
|
35425
35662
|
name?: string;
|
|
35426
35663
|
/**
|
|
35427
|
-
*
|
|
35664
|
+
* Indicate that this setting was shared via the Orgs API and read only for the current account.
|
|
35428
35665
|
*/
|
|
35429
35666
|
readOnly: boolean;
|
|
35430
35667
|
/**
|
|
35431
|
-
*
|
|
35668
|
+
* Indicate the account tag of the account that shared this setting.
|
|
35432
35669
|
*/
|
|
35433
35670
|
sourceAccount: string;
|
|
35434
35671
|
/**
|
|
35435
|
-
*
|
|
35672
|
+
* Specify whether to suppress detailed information at the bottom of the block page when the mode is customized*block*page.
|
|
35436
35673
|
*/
|
|
35437
35674
|
suppressFooter?: boolean;
|
|
35438
35675
|
/**
|
|
35439
|
-
*
|
|
35676
|
+
* Specify the URI to redirect users to when the mode is redirect_uri.
|
|
35440
35677
|
*/
|
|
35441
35678
|
targetUri?: string;
|
|
35442
35679
|
/**
|
|
35443
|
-
*
|
|
35680
|
+
* Indicate the version number of the setting.
|
|
35444
35681
|
*/
|
|
35445
35682
|
version: number;
|
|
35446
35683
|
}
|
|
35447
35684
|
export interface ZeroTrustGatewaySettingsSettingsBodyScanning {
|
|
35448
35685
|
/**
|
|
35449
|
-
*
|
|
35686
|
+
* Specify the inspection mode as either `deep` or `shallow`.
|
|
35450
35687
|
* Available values: "deep", "shallow".
|
|
35451
35688
|
*/
|
|
35452
35689
|
inspectionMode?: string;
|
|
35453
35690
|
}
|
|
35454
35691
|
export interface ZeroTrustGatewaySettingsSettingsBrowserIsolation {
|
|
35455
35692
|
/**
|
|
35456
|
-
*
|
|
35693
|
+
* Specify whether to enable non-identity onramp support for Browser Isolation.
|
|
35457
35694
|
*/
|
|
35458
35695
|
nonIdentityEnabled?: boolean;
|
|
35459
35696
|
/**
|
|
35460
|
-
*
|
|
35697
|
+
* Specify whether to enable Clientless Browser Isolation.
|
|
35461
35698
|
*/
|
|
35462
35699
|
urlBrowserIsolationEnabled?: boolean;
|
|
35463
35700
|
}
|
|
35464
35701
|
export interface ZeroTrustGatewaySettingsSettingsCertificate {
|
|
35465
35702
|
/**
|
|
35466
|
-
* UUID of certificate
|
|
35703
|
+
* Specify the UUID of the certificate used for interception. Ensure the certificate is available at the edge(previously called 'active'). A nil UUID directs Cloudflare to use the Root CA.
|
|
35467
35704
|
*/
|
|
35468
35705
|
id: string;
|
|
35469
35706
|
}
|
|
35470
35707
|
export interface ZeroTrustGatewaySettingsSettingsCustomCertificate {
|
|
35471
35708
|
/**
|
|
35472
|
-
*
|
|
35709
|
+
* Indicate the internal certificate status.
|
|
35473
35710
|
*/
|
|
35474
35711
|
bindingStatus: string;
|
|
35475
35712
|
/**
|
|
35476
|
-
*
|
|
35713
|
+
* Specify whether to enable a custom certificate authority for signing Gateway traffic.
|
|
35477
35714
|
*/
|
|
35478
35715
|
enabled: boolean;
|
|
35479
35716
|
/**
|
|
35480
|
-
* UUID of certificate (ID from MTLS certificate store).
|
|
35717
|
+
* Specify the UUID of the certificate (ID from MTLS certificate store).
|
|
35481
35718
|
*/
|
|
35482
35719
|
id?: string;
|
|
35483
35720
|
updatedAt: string;
|
|
35484
35721
|
}
|
|
35485
35722
|
export interface ZeroTrustGatewaySettingsSettingsExtendedEmailMatching {
|
|
35486
35723
|
/**
|
|
35487
|
-
*
|
|
35724
|
+
* Specify whether to match all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.
|
|
35488
35725
|
*/
|
|
35489
35726
|
enabled?: boolean;
|
|
35490
35727
|
/**
|
|
35491
|
-
*
|
|
35728
|
+
* Indicate that this setting was shared via the Orgs API and read only for the current account.
|
|
35492
35729
|
*/
|
|
35493
35730
|
readOnly: boolean;
|
|
35494
35731
|
/**
|
|
35495
|
-
*
|
|
35732
|
+
* Indicate the account tag of the account that shared this setting.
|
|
35496
35733
|
*/
|
|
35497
35734
|
sourceAccount: string;
|
|
35498
35735
|
/**
|
|
35499
|
-
*
|
|
35736
|
+
* Indicate the version number of the setting.
|
|
35500
35737
|
*/
|
|
35501
35738
|
version: number;
|
|
35502
35739
|
}
|
|
35503
35740
|
export interface ZeroTrustGatewaySettingsSettingsFips {
|
|
35504
35741
|
/**
|
|
35505
|
-
*
|
|
35742
|
+
* Enforce cipher suites and TLS versions compliant with FIPS 140-2.
|
|
35506
35743
|
*/
|
|
35507
35744
|
tls?: boolean;
|
|
35508
35745
|
}
|
|
35509
35746
|
export interface ZeroTrustGatewaySettingsSettingsHostSelector {
|
|
35510
35747
|
/**
|
|
35511
|
-
*
|
|
35748
|
+
* Specify whether to enable filtering via hosts for egress policies.
|
|
35512
35749
|
*/
|
|
35513
35750
|
enabled?: boolean;
|
|
35514
35751
|
}
|
|
35515
35752
|
export interface ZeroTrustGatewaySettingsSettingsInspection {
|
|
35516
35753
|
/**
|
|
35517
|
-
*
|
|
35518
|
-
* - static: Gateway will use static inspection to inspect HTTP on TCP(80). If TLS decryption is on, Gateway will inspect HTTPS traffic on TCP(443) & UDP(443).
|
|
35519
|
-
* - dynamic: Gateway will use protocol detection to dynamically inspect HTTP and HTTPS traffic on any port. TLS decryption must be on to inspect HTTPS traffic.
|
|
35754
|
+
* Define the proxy inspection mode. 1. static: Gateway applies static inspection to HTTP on TCP(80). With TLS decryption on, Gateway inspects HTTPS traffic on TCP(443) and UDP(443). 2. dynamic: Gateway applies protocol detection to inspect HTTP and HTTPS traffic on any port. TLS decryption must remain on to inspect HTTPS traffic.
|
|
35520
35755
|
* Available values: "static", "dynamic".
|
|
35521
35756
|
*/
|
|
35522
35757
|
mode?: string;
|
|
35523
35758
|
}
|
|
35524
35759
|
export interface ZeroTrustGatewaySettingsSettingsProtocolDetection {
|
|
35525
35760
|
/**
|
|
35526
|
-
*
|
|
35761
|
+
* Specify whether to detect protocols from the initial bytes of client traffic.
|
|
35527
35762
|
*/
|
|
35528
35763
|
enabled?: boolean;
|
|
35529
35764
|
}
|
|
35530
35765
|
export interface ZeroTrustGatewaySettingsSettingsSandbox {
|
|
35531
35766
|
/**
|
|
35532
|
-
*
|
|
35767
|
+
* Specify whether to enable the sandbox.
|
|
35533
35768
|
*/
|
|
35534
35769
|
enabled?: boolean;
|
|
35535
35770
|
/**
|
|
35536
|
-
*
|
|
35771
|
+
* Specify the action to take when the system cannot scan the file.
|
|
35537
35772
|
* Available values: "allow", "block".
|
|
35538
35773
|
*/
|
|
35539
35774
|
fallbackAction?: string;
|
|
35540
35775
|
}
|
|
35541
35776
|
export interface ZeroTrustGatewaySettingsSettingsTlsDecrypt {
|
|
35542
35777
|
/**
|
|
35543
|
-
*
|
|
35778
|
+
* Specify whether to inspect encrypted HTTP traffic.
|
|
35544
35779
|
*/
|
|
35545
35780
|
enabled?: boolean;
|
|
35546
35781
|
}
|
|
35547
35782
|
export interface ZeroTrustListItem {
|
|
35548
35783
|
/**
|
|
35549
|
-
*
|
|
35784
|
+
* Provide the list item description (optional).
|
|
35550
35785
|
*/
|
|
35551
35786
|
description?: string;
|
|
35552
35787
|
/**
|
|
35553
|
-
*
|
|
35788
|
+
* Specify the item value.
|
|
35554
35789
|
*/
|
|
35555
35790
|
value?: string;
|
|
35556
35791
|
}
|
|
@@ -35915,37 +36150,37 @@ export interface ZoneDnsSettingsNameservers {
|
|
|
35915
36150
|
* Nameserver type
|
|
35916
36151
|
* Available values: "cloudflare.standard", "custom.account", "custom.tenant", "custom.zone".
|
|
35917
36152
|
*/
|
|
35918
|
-
type
|
|
36153
|
+
type?: string;
|
|
35919
36154
|
}
|
|
35920
36155
|
export interface ZoneDnsSettingsSoa {
|
|
35921
36156
|
/**
|
|
35922
36157
|
* Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
|
|
35923
36158
|
*/
|
|
35924
|
-
expire
|
|
36159
|
+
expire?: number;
|
|
35925
36160
|
/**
|
|
35926
36161
|
* The time to live (TTL) for negative caching of records within the zone.
|
|
35927
36162
|
*/
|
|
35928
|
-
minTtl
|
|
36163
|
+
minTtl?: number;
|
|
35929
36164
|
/**
|
|
35930
|
-
* The primary nameserver, which may be used for outbound zone transfers.
|
|
36165
|
+
* The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
|
|
35931
36166
|
*/
|
|
35932
|
-
mname
|
|
36167
|
+
mname?: string;
|
|
35933
36168
|
/**
|
|
35934
36169
|
* Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
|
|
35935
36170
|
*/
|
|
35936
|
-
refresh
|
|
36171
|
+
refresh?: number;
|
|
35937
36172
|
/**
|
|
35938
36173
|
* Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
|
|
35939
36174
|
*/
|
|
35940
|
-
retry
|
|
36175
|
+
retry?: number;
|
|
35941
36176
|
/**
|
|
35942
36177
|
* The email address of the zone administrator, with the first label representing the local part of the email address.
|
|
35943
36178
|
*/
|
|
35944
|
-
rname
|
|
36179
|
+
rname?: string;
|
|
35945
36180
|
/**
|
|
35946
36181
|
* The time to live (TTL) of the SOA record itself.
|
|
35947
36182
|
*/
|
|
35948
|
-
ttl
|
|
36183
|
+
ttl?: number;
|
|
35949
36184
|
}
|
|
35950
36185
|
export interface ZoneLockdownConfiguration {
|
|
35951
36186
|
/**
|