Skip to main content

CampaignSummary

Import this model from the entry point of its package:

import { CampaignSummary } from '@sailpoint/angular-sdk/gov_certification';

Properties​

NameTypeDescriptionNotes
id(optional) stringID of the campaign[readonly] [default to undefined]
namestringThe campaign name. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.[default to undefined]
descriptionstringThe campaign description. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.[default to undefined]
deadline(optional) stringThe campaign's completion deadline date.[default to undefined]
deadlineTimezone(optional) stringThe timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh.[default to undefined]
deadlineTime(optional) stringCalculated deadline time in UTC timezone of the campaign calculated from the deadline and the deadlineTimezone[default to undefined]
emailNotificationEnabled(optional) booleanEnables email notification for this campaign[default to false]
autoRevokeAllowed(optional) booleanAllows auto revoke for this campaign[default to false]
recommendationsEnabled(optional) booleanEnables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.[default to false]
sunsetCommentsRequired(optional) booleanDetermines if comments on sunset date changes are required.[default to true]
mandatoryCommentRequirement(optional) CampaignMandatoryCommentRequirement[default to undefined]
typeCampaignType[default to undefined]
reviewer(optional) Reviewer[default to undefined]
alerts(optional) Array<Alert>A list of errors and warnings that have accumulated.[readonly] [default to undefined]
created(optional) stringCreated time of the campaign[readonly] [default to undefined]
modified(optional) stringModified time of the campaign[readonly] [default to undefined]
totalCertifications(optional) numberThe total number of certifications in this campaign.[readonly] [default to undefined]
completedCertifications(optional) numberThe number of completed certifications in this campaign.[readonly] [default to undefined]
status(optional) stringThe campaign's current status.[readonly] [default to undefined]
generationType(optional) CampaignGenerationType[readonly] [default to undefined]