Skip to main content

Slimcampaign

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. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.[default to undefined]
typestringThe type of campaign. Could be extended in the future.[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]
status(optional) stringThe campaign's current status.[readonly] [default to undefined]
correlatedStatus(optional) stringThe correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).[default to undefined]
created(optional) stringCreated 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]
alerts(optional) Array<Campaignalert>A list of errors and warnings that have accumulated.[readonly] [default to undefined]