Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.57 KB

SadomainCreateRuleRequestV1.md

File metadata and controls

30 lines (24 loc) · 1.57 KB
Raw

Falcon::SadomainCreateRuleRequestV1

Properties

Name Type Description Notes
breach_monitoring_enabled Boolean Whether to monitor for breach data. Available only for `Company Domains` and `Email addresses` rule topics. When enabled, ownership of the monitored domains or emails is required
filter String The FQL filter to be used for searching
name String The name of a given rule
permissions String The permissions for a given rule which specifies the rule's access by other users. Possible values: [`public`, `private`]
priority String The priority for a given rule. Possible values: [`low`, `medium`, `high`]
substring_matching_enabled Boolean Whether to monitor for substring matches. Only available for the `Typosquatting` topic.
topic String The topic of a given rule. Possible values: [`SA_BRAND_PRODUCT`, `SA_VIP`, `SA_THIRD_PARTY`, `SA_IP`, `SA_CVE`, `SA_BIN`, `SA_DOMAIN`, `SA_EMAIL`, `SA_ALIAS`, `SA_AUTHOR`, `SA_CUSTOM`, `SA_TYPOSQUATTING`]

Example

require 'crimson-falcon'

instance = Falcon::SadomainCreateRuleRequestV1.new(
  breach_monitoring_enabled: null,
  filter: null,
  name: null,
  permissions: null,
  priority: null,
  substring_matching_enabled: null,
  topic: null
)