PendingChangeItem

PendingChangeItem
PendingChangeItem

One difference between what a Publish would compile now and the live published bundle. Never carries match patterns, paths or hashes.

JSON Example
{
    "changeType": "string",
    "ruleId": 0,
    "ruleName": "string",
    "ruleType": "string",
    "action": "string",
    "isBuiltIn": false,
    "policyId": 0,
    "policyName": "string",
    "fromRevision": 0,
    "toRevision": 0,
    "fromPosition": 0,
    "toPosition": 0,
    "changedAspects": [
        "string"
    ],
    "fromAction": "string",
    "toAction": "string"
}
changeType
Required  

Kind of difference between a Publish and the live bundle.

  • RULE_ADDED: A staged rule the live bundle does not have; fromPosition and fromRevision are null
  • RULE_REMOVED: A live rule the staged state no longer has; toPosition and toRevision are null and so is policyId
  • RULE_CHANGED: A rule in both whose compiled content differs, the revision ignored; changedAspects names what differs
  • ORDER_CHANGED: A rule in both that is outside the longest run of shared rules keeping their relative order, so it has really moved; fromPosition and toPosition give the 1-based positions. A rule that is both changed and moved appears twice, as RULE_CHANGED and as ORDER_CHANGED
Enumeration: RULE_ADDED, RULE_REMOVED, RULE_CHANGED, ORDER_CHANGED
integer As int64 As int64
ruleId
Required  

Identifier of the rule, from the compiled rule header. For a per-user SSH MFA rule (added, removed or changed) this is the Console template rule id and its name, never the expanded per-user id carried in the bundle

string
ruleName
Required  

Name of the rule as compiled: the staged rule's, or the live rule's for RULE_REMOVED

string
ruleType
Required  

Rule type code from the compiled rule, without the RULE_TYPE_ prefix of the agent protocol: PATH_FILE_CMD, HASH, PUBLISHER_SIGNING, MFA, ANTI_TAMPER or VIB_REPUTATION in this release; further codes are added by new releases

action
Required  

Default action of the staged rule (the live rule for RULE_REMOVED)

boolean
isBuiltIn
Required  

True for a Built-in Rule (the compiled rule's locked flag, set from the rule's built-in flag)

integer As int64 As int64
policyId
Optional

Policy the staged rule currently comes from; null for RULE_REMOVED

string
policyName
Optional

Name of the Policy identified by policyId. Null when policyId is null

integer As int32 As int32
fromRevision
Optional

Revision of the live rule. Null for RULE_ADDED

integer As int32 As int32
toRevision
Optional

Revision of the staged rule. Null for RULE_REMOVED

integer As int32 As int32
fromPosition
Optional

1-based position in the live bundle; null for RULE_ADDED

integer As int32 As int32
toPosition
Optional

1-based position in the staged bundle; null for RULE_REMOVED

array of RuleAspect
changedAspects
Optional

RULE_CHANGED only

fromAction
Optional

RULE_CHANGED only, when ACTION is among the aspects

toAction
Optional

RULE_CHANGED only, when ACTION is among the aspects