FileCatalogRuleDto

FileCatalogRuleDto
FileCatalogRuleDto

The catalog rule of an entry.

JSON Example
{
    "ruleId": 0,
    "name": "string",
    "action": "string",
    "ruleRank": "string",
    "isEnabled": false,
    "attachment": "string",
    "attachedPolicyCount": 0
}
integer As int64 As int64
ruleId
Required  

Identifier of the rule mapped to the catalog entry. A rule created from the catalog is a HASH rule of rank CUSTOM_GLOBAL

string
name
Required  

Current name of the mapped rule

action
Required  

Default verdict of a Rule. MFA_REQUIRED is accepted only for ruleType MFA (any other type is refused with 400 INVALID_RULE_ACTION).

  • ALLOW: The operation is permitted
  • BLOCK: The operation is aborted with -EPERM
  • AUDIT: The operation is logged and alerted, and execution is permitted
  • MFA_REQUIRED: Triggers an interactive TOTP challenge through PAM; accepted only for ruleType MFA
Enumeration: ALLOW, BLOCK, AUDIT, MFA_REQUIRED
ruleRank
Required  

Evaluation rank: CUSTOM_LOCAL (custom rules) first, then CUSTOM_GLOBAL (SHA-256 rules created from the file catalog), then VIRTUAL_PATCHING, then DEFAULT_ATTACK. It decides the order rules are sent to the agent, ahead of Policy stack rank and sequence.

  • UNSPECIFIED: Built-in Rules from a Rule Pack whose vendor rank is unset
  • CUSTOM_LOCAL: Custom rules created on the Rules page; the default for a Custom Rule and the highest priority. Rule ids 1 to 999,999
  • CUSTOM_GLOBAL: Custom SHA-256 rules created from the file catalog, evaluated after CUSTOM_LOCAL. Rule ids 1,000,000 to 9,999,999
  • VIRTUAL_PATCHING: Built-in Rules from a Rule Pack, evaluated after CUSTOM_GLOBAL. Rule ids 10,000,000 to 99,999,999
  • DEFAULT_ATTACK: Built-in Rules from a Rule Pack, evaluated last. Rule ids 100,000,000 to 999,999,999
Enumeration: UNSPECIFIED, CUSTOM_LOCAL, CUSTOM_GLOBAL, VIRTUAL_PATCHING, DEFAULT_ATTACK
boolean
isEnabled
Required  

The rule's own enabled flag: a disabled rule enforces nothing even while the entry still shows Banned or Approved

attachment
Required  

Whether the rule is in any Policy. The catalog never attaches rules, so a new catalog rule is NOT_ATTACHED and enforces nothing; ATTACHED does not prove enforcement either, because the Policy and its Groups must also be published.

  • NOT_ATTACHED: The rule is in no Policy (attachedPolicyCount is 0)
  • ATTACHED: The rule is in at least one Policy
Enumeration: NOT_ATTACHED, ATTACHED
integer As int64 As int64
attachedPolicyCount
Required  

Number of Policies the rule is attached to