PolicyDto

PolicyDto
PolicyDto

A Policy.

JSON Example
{
    "policyId": 0,
    "name": "string",
    "description": "string",
    "createdBy": 0,
    "createdByUsername": "string",
    "updatedBy": 0,
    "updatedByUsername": "string",
    "groupCount": 0,
    "ruleCount": 0,
    "pendingGroupCount": 0,
    "publishedVersion": 0,
    "hasUnpublishedChanges": false,
    "createdAt": "string",
    "updatedAt": "string"
}
integer As int64 As int64
policyId
Required  

Identifier of the Policy, assigned by the server when the Policy is created

string
name
Required  

Policy name, stored trimmed, at most 255 characters, and different from every other Policy's name ignoring case

string
description
Optional

Free text, stored trimmed, at most 2,000 characters; a whitespace-only text is stored as an empty string. Null when none was given

integer As int64 As int64
createdBy
Optional

Identifier of the user who created the Policy. Null when no user is recorded

string
createdByUsername
Optional

Username of createdBy; absent when createdBy is absent or the user no longer exists

integer As int64 As int64
updatedBy
Optional

Identifier of the user who last edited the Policy's name or description (the creator until then). Null when no user is recorded

string
updatedByUsername
Optional

Username of updatedBy; absent when updatedBy is absent or the user no longer exists

integer As int64 As int64
groupCount
Required  

Number of Groups the Policy is attached to

integer As int64 As int64
ruleCount
Required  

Number of Rules attached to the Policy

integer As int64 As int64
pendingGroupCount
Required  

Number of attached Groups whose hasPendingChanges flag is set. Read it as 'N attached groups have unpublished changes', never as 'this policy changed'.

integer As int64 As int64
publishedVersion
Required  

Number of times the Policy has been published; 0 means never published

boolean
hasUnpublishedChanges
Required  

True when a Rule or attachment change has not been published to the Policy's snapshot

string As date-time As date-time
createdAt
Required  

When the Policy was created, as an ISO 8601 date-time with offset; never changes

string As date-time As date-time
updatedAt
Required  

When the Policy was last updated, as an ISO 8601 date-time with offset