GroupPendingChangesDto

GroupPendingChangesDto
GroupPendingChangesDto

Staged versus live comparison for one Group. hasNetChanges is false when the staged state equals the live state even if hasPendingChanges is still set.

JSON Example
{
    "groupId": 0,
    "groupName": "string",
    "hasPendingChanges": false,
    "isNeverPublished": false,
    "hasNetChanges": false,
    "currentPublishedVersion": 0,
    "publishedRuleCount": 0,
    "stagedRuleCount": 0,
    "changes": [
        {
            "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"
        }
    ],
    "mfaCredentialChanges": [
        {
            "username": "string",
            "userId": 0,
            "change": "string"
        }
    ],
    "affectedPolicies": [
        {
            "policyId": 0,
            "policyName": "string",
            "reason": "string"
        }
    ],
    "policiesAwaitingPublish": [
        {
            "policyId": 0,
            "policyName": "string"
        }
    ]
}
integer As int64 As int64
groupId
Required  

Identifier of the Group

string
groupName
Required  

Current name of the Group

boolean
hasPendingChanges
Required  

The Group's stored flag (see hasPendingChanges of the Group). It can be true while hasNetChanges is false

boolean
isNeverPublished
Required  

No published row or an empty payload; changes is then empty

boolean
hasNetChanges
Required  

True when a Publish would send something other than the live bundle: changes or mfaCredentialChanges is not empty. For a Group that was never published, true when the staged state has at least one rule or credential change

integer As int64 As int64
currentPublishedVersion
Required  

The Group's current policy version, the version of its live bundle. A Group never published has a version but no bundle

integer As int32 As int32
publishedRuleCount
Required  

Number of rules in the live bundle; 0 when the Group was never published

integer As int32 As int32
stagedRuleCount
Required  

Number of rules a Publish would compile now

changes
Required  

Differences between the live bundle and the staged rules: for each staged rule in staged order its RULE_ADDED, or its RULE_CHANGED and then its ORDER_CHANGED, followed by the RULE_REMOVED items in live order. Empty when the Group was never published

mfaCredentialChanges
Required  

SSH MFA credentials the Publish would add, remove or rotate, sorted by username

affectedPolicies
Required  

Policies whose published version, attachment or stack rank differs from the last Group publish

policiesAwaitingPublish
Required  

Attached Policies with unpublished changes of their own; publish those Policies first