dlp_web_rules

Documentation

Index

• type Service
  • func New(c *zia.Client) *Service
  • func (service *Service) Create(ruleID *WebDLPRules) (*WebDLPRules, error)
  • func (service *Service) Delete(ruleID int) (*http.Response, error)
  • func (service *Service) Get(ruleID int) (*WebDLPRules, error)
  • func (service *Service) GetAll() ([]WebDLPRules, error)
  • func (service *Service) GetByName(ruleName string) (*WebDLPRules, error)
  • func (service *Service) Update(ruleID int, webDlpRules *WebDLPRules) (*WebDLPRules, error)
• type WebDLPRules

Types

type Service

type Service struct {
	Client *zia.Client
}

func New

func New(c *zia.Client) *Service

func (*Service) Create

func (service *Service) Create(ruleID *WebDLPRules) (*WebDLPRules, error)

func (*Service) Delete

func (service *Service) Delete(ruleID int) (*http.Response, error)

func (*Service) Get

func (service *Service) Get(ruleID int) (*WebDLPRules, error)

func (*Service) GetAll

func (service *Service) GetAll() ([]WebDLPRules, error)

func (*Service) GetByName

func (service *Service) GetByName(ruleName string) (*WebDLPRules, error)

func (*Service) Update

func (service *Service) Update(ruleID int, webDlpRules *WebDLPRules) (*WebDLPRules, error)

type WebDLPRules

type WebDLPRules struct {
	// The unique identifier for the DLP policy rule.
	ID int `json:"id,omitempty"`

	// The rule order of execution for the DLP policy rule with respect to other rules.
	Order int `json:"order,omitempty"`
	// The access privilege for this DLP policy rule based on the admin's state.
	AccessControl string `json:"accessControl,omitempty"`

	// The protocol criteria specified for the DLP policy rule.
	Protocols []string `json:"protocols,omitempty"`

	// The admin rank of the admin who created the DLP policy rule.
	Rank int `json:"rank,omitempty"`

	// The DLP policy rule name.
	Name string `json:"name,omitempty"`

	// The description of the DLP policy rule.
	Description string `json:"description,omitempty"`

	// The list of file types to which the DLP policy rule must be applied.
	FileTypes []string `json:"fileTypes,omitempty"`

	// The list of cloud applications to which the DLP policy rule must be applied.
	CloudApplications []string `json:"cloudApplications,omitempty"`

	// The minimum file size (in KB) used for evaluation of the DLP policy rule.
	MinSize int `json:"minSize,omitempty"`

	// The action taken when traffic matches the DLP policy rule criteria.
	Action string `json:"action,omitempty"`

	// Enables or disables the DLP policy rule.
	State string `json:"state,omitempty"`

	// The match only criteria for DLP engines.
	MatchOnly bool `json:"matchOnly,omitempty"`

	// Timestamp when the DLP policy rule was last modified.
	LastModifiedTime int `json:"lastModifiedTime,omitempty"`

	// Indicates a DLP policy rule without content inspection, when the value is set to true.
	WithoutContentInspection bool `json:"withoutContentInspection,omitempty"`

	// Enables or disables image file scanning.
	OcrEnabled bool `json:"ocrEnabled,omitempty"`

	// If this field is set to true, DLP scan is enabled for file downloads from cloud applications configured in the rule.
	// If this field is set to false, DLP scan is disabled for downloads from the cloud applications.
	DLPDownloadScanEnabled bool `json:"dlpDownloadScanEnabled,omitempty"`

	// If this field is set to true, Zscaler Client Connector notification is enabled for the block action triggered by the web DLP rule.
	// If this field is set to false, Zscaler Client Connector notification is disabled.
	ZCCNotificationsEnabled bool `json:"zccNotificationsEnabled,omitempty"`

	// Indicates whether a Zscaler Incident Receiver is associated to the DLP policy rule.
	ZscalerIncidentReceiver bool `json:"zscalerIncidentReceiver,omitempty"`

	// The email address of an external auditor to whom DLP email notifications are sent.
	ExternalAuditorEmail string `json:"externalAuditorEmail,omitempty"`

	// The auditor to which the DLP policy rule must be applied.
	Auditor *common.IDCustom `json:"auditor,omitempty"`

	// The admin that modified the DLP policy rule last.
	LastModifiedBy *common.IDNameExtensions `json:"lastModifiedBy,omitempty"`

	// The template used for DLP notification emails.
	NotificationTemplate *common.IDCustom `json:"notificationTemplate,omitempty"`

	// The DLP server, using ICAP, to which the transaction content is forwarded.
	IcapServer *common.IDCustom `json:"icapServer,omitempty"`

	// The Name-ID pairs of locations to which the DLP policy rule must be applied.
	Locations []common.IDNameExtensions `json:"locations,omitempty"`

	// The Name-ID pairs of locations groups to which the DLP policy rule must be applied.
	LocationGroups []common.IDNameExtensions `json:"locationGroups,omitempty"`

	// The Name-ID pairs of groups to which the DLP policy rule must be applied.
	Groups []common.IDNameExtensions `json:"groups,omitempty"`

	// The Name-ID pairs of departments to which the DLP policy rule must be applied.
	Departments []common.IDNameExtensions `json:"departments,omitempty"`

	// The Name-ID pairs of users to which the DLP policy rule must be applied.
	Users []common.IDNameExtensions `json:"users,omitempty"`

	// The list of URL categories to which the DLP policy rule must be applied.
	URLCategories []common.IDNameExtensions `json:"urlCategories,omitempty"`

	// The list of DLP engines to which the DLP policy rule must be applied.
	DLPEngines []common.IDNameExtensions `json:"dlpEngines,omitempty"`

	// The Name-ID pairs of time windows to which the DLP policy rule must be applied.
	TimeWindows []common.IDNameExtensions `json:"timeWindows,omitempty"`

	// The Name-ID pairs of rule labels associated to the DLP policy rule.
	Labels []common.IDNameExtensions `json:"labels,omitempty"`

	// The name-ID pairs of the groups that are excluded from the DLP policy rule.
	ExcludedGroups []common.IDNameExtensions `json:"excludedGroups,omitempty"`

	// The name-ID pairs of the departments that are excluded from the DLP policy rule.
	ExcludedDepartments []common.IDNameExtensions `json:"excludedDepartments,omitempty"`

	// The name-ID pairs of the users that are excluded from the DLP policy rule.
	ExcludedUsers []common.IDNameExtensions `json:"excludedUsers,omitempty"`

	// The list of domain profiles that must be added to the DLP rule criteria in order to apply the DLP rules only to domains that are part of the specified profiles. A maximum of 8 profiles can be selected.
	IncludedDomainProfiles []common.IDNameExtensions `json:"includedDomainProfiles,omitempty"`

	// The list of domain profiles that must be added to the DLP rule criteria in order to apply the DLP rules to all domains excluding the domains that are part of the specified profiles. A maximum of 8 profiles can be selected.
	ExcludedDomainProfiles []common.IDNameExtensions `json:"excludedDomainProfiles,omitempty"`

	// Source IP address groups for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address group.
	SourceIpGroups []common.IDNameExtensions `json:"sourceIpGroups,omitempty"`

	// The list of preconfigured workload groups to which the policy must be applied.
	WorkloadGroups []common.IDName `json:"workloadGroups,omitempty"`

	// Indicates the severity selected for the DLP rule violation
	Severity string `json:"severity,omitempty"`

	// The unique identifier of the parent rule under which an exception rule is added.
	// Note: Exception rules can be configured only when the inline DLP rule evaluation type is set to evaluate all DLP rules in the DLP Advanced Settings.
	ParentRule int `json:"parentRule,omitempty"`

	// The list of exception rules added to a parent rule.
	// All attributes within the WebDlpRule model are applicable to the sub-rules.
	// Values for each rule are specified by using the WebDlpRule object.
	SubRules []string `json:"subRules,omitempty"`

	UserRiskScoreLevels []string `json:"userRiskScoreLevels,omitempty"`
}