Groups Api Get Group Pending Changes

Groups Api Get Group Pending Changes
What a Group publish would change

Compares the compiled staged state with the live published bundle. Read-only. Requires the ADMIN or SECURITY_OPERATOR role.

Request
URI
GET
https://{api_host}/api/v1/groups/{id}/pending-changes
COPY
Path Parameters
integer
id
Required  

Security Group id

id example
1

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The changes pending publication for the Group

Returns GroupPendingChangesDto of type(s) application/json
{
    "groupId": 1,
    "groupName": "Production Servers",
    "hasPendingChanges": true,
    "isNeverPublished": false,
    "hasNetChanges": true,
    "currentPublishedVersion": 3,
    "publishedRuleCount": 20,
    "stagedRuleCount": 20,
    "changes": [
        {
            "changeType": "RULE_CHANGED",
            "ruleId": 7,
            "ruleName": "Audit Shell Spawn",
            "ruleType": "PATH_FILE_CMD",
            "action": "AUDIT",
            "isBuiltIn": false,
            "policyId": 2,
            "policyName": "Production Policy",
            "fromRevision": 1,
            "toRevision": 2,
            "fromPosition": 16,
            "toPosition": 16,
            "changedAspects": [
                "ACTION"
            ],
            "fromAction": "BLOCK",
            "toAction": "AUDIT"
        }
    ],
    "mfaCredentialChanges": [],
    "affectedPolicies": [
        {
            "policyId": 2,
            "policyName": "Production Policy",
            "reason": "UPDATED"
        }
    ],
    "policiesAwaitingPublish": [
        {
            "policyId": 2,
            "policyName": "Production Policy"
        }
    ]
}
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

array of object
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

array of object
mfaCredentialChanges
Required  

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

array of object
affectedPolicies
Required  

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

array of object
policiesAwaitingPublish
Required  

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


400

400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden: FORBIDDEN

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


404

404 Not Found: SECURITY_GROUP_NOT_FOUND

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/groups/{id}/pending-changes