| Id |
Pointer to String |
Id of the campaign |
[optional] [readonly] |
| Name |
String |
The campaign name. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details. |
[required] |
| Description |
String |
The campaign description. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details. |
[required] |
| Deadline |
Pointer to System.DateTime |
The 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. |
[optional] |
| Type |
Enum [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] |
The type of campaign. Could be extended in the future. |
[required] |
| EmailNotificationEnabled |
Pointer to Boolean |
Enables email notification for this campaign |
[optional] [default to $false] |
| AutoRevokeAllowed |
Pointer to Boolean |
Allows auto revoke for this campaign |
[optional] [default to $false] |
| RecommendationsEnabled |
Pointer to Boolean |
Enables 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. |
[optional] [default to $false] |
| Status |
Pointer to Enum [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] |
The campaign's current status. |
[optional] [readonly] |
| CorrelatedStatus |
Pointer to Enum [ "CORRELATED", "UNCORRELATED" ] |
The 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). |
[optional] |
| Created |
Pointer to System.DateTime |
Created time of the campaign |
[optional] [readonly] |
| TotalCertifications |
Pointer to Int32 |
The total number of certifications in this campaign. |
[optional] [readonly] |
| CompletedCertifications |
Pointer to Int32 |
The number of completed certifications in this campaign. |
[optional] [readonly] |
| Alerts |
Pointer to []CampaignAlert |
A list of errors and warnings that have accumulated. |
[optional] [readonly] |