Deprecated - Create a campaign configuration.

The api to create a campaign configuration v1.0 (v1.0/admin/campaigns) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: POST /v2.0/campaigns
Create a campaign configuration. The optional reviewer, if specified, can be any existing userId. For account campaign, blocklist contains default "unmatched" account statuses. If you want to retrieve unmatched accounts as well, you must explicitly add them into the allowlist.
Entitlements required: manageAccessCertification [Manage Access Certification].

Body Params

Campaign configuration payload details:

- owner: Information about the campaign owner.
- type: Type of campaign (For example, userassignment, groupassignment, account).
- priority: Priority of the campaign (For example, high, medium, low ).
- name: Name of the campaign.
- description: Description of the campaign.
- reviewer: Information about the campaign reviewer.
- applications: List of applications the campaign certifies.
Note: This is a required field, however, in case of User entitlement campaigns, either the 'Applications' or 'Entitlement' or both must be specified.
- allowlist: List of users or groups allowed for the certification. You cannot specify the block list with the allow list in the User/Group scope.
- blocklist: List of users or groups excluded from the certification. You cannot specify the allow list with the block list in the User/Group scope.
- entitlementFilter: It is set to filter the list of included or excluded entitlements for certification.


You can either specify entitlementInclusionList or entitlementExclusionList in entitlementFilter.
- launchDate: Date when the first instance of the campaign starts.
- creationDate: Creation date of the campaign configuration.
- duration: The duration (in milliseconds) for which each campaign instance remains open.
- frequency: A UNIX or Linux Cron-compatible string that defines the start of subsequent instances.
- runEvery: Frequency unit for campaign instance (days or months).
- runNow: Flag to start the campaign immediately.
- nextRunDate: Forecasted Run Date for the next campaign instance.
- overdueAction: Action for open records when a campaign closes.
- mitigationAction: Action after a campaign closes to avoid open records.
- defaultReviewer: Default reviewer for assignments without a suitable reviewer.
- preview: A flag indicating that the campaign is in preview mode and not open to reviewers.
- continuous:A flag indicating that the campaign is continuous.
- automaticRefreshContinuousCampaign:A flag, valid for continuous campaigns only, saying that campaign should refresh the existing filter for building dataset.
- signOff: Campaign sign-off policy refers to the pre-determined approach that governs when and how campaign actions are officially approved or denied (auto, manual, eoc, no_signoff).


Allowable values for signOff are: auto, manual, eoc or no_signoff.
auto: The setting would mean immediate sign-off. Actions taken by the approver in terms of approve or reject are applied on the assignment immediately).
manual: The setting would mean a manual sign-off. The certifier can decide for himself if he wants to enforce his action immediately OR at the end of the campaign).
eoc: The setting would mean sign-off towards the end of the campaign. Actions taken by the approver in terms of approval or rejection are persisted till the Due date of the campaign and then rolled out together).
no_signoff: Actions are not executed and only used for reporting.


- supervisors: List of supervisors identified for the campaign.
- allowSupervisorEscalation: Allow escalation to supervisors.
- reviewerOverwritten: Flag indicating if the reviewer is manually overwritten.

object

Represents a user group

string
required

Campaign type

string
required

Campaign priority

string
required

Campaign name

string

Campaign description

object

Represents a user group

array of objects
required

List of applications the campaign the campaign certifies

applications*
array of objects

List of users or groups that are allowed for the certification

allowlist
array of objects

List of users or groups denied for the certification

blocklist
object

List of entitlements for inclusion/exclusion or filter for entitlements allowed for the certification

string
required

Date when the first instance of the campaign starts

string

The creation date of the campaign configuration.

int64
required

The The duration (in milliseconds) for which each campaign instance remains open

string

A UNIX or Linux Cron-compatible string that defines the start of subsequent instances

object

Frequency unit days or months

boolean

A flag to start that the campaign immediately

string

Forecasted Run date for the next campaign instance.

string

The action to be taken for open records when a campaign closes.

object

The action to be taken after a while to avoid open records when a campaign closes.

object

Represents a user group

boolean

A flag for a preview campaign, not opened to reviewers

boolean

A flag indicating that the campaign is continuous.

boolean

A flag, valid for continuous campaigns only, saying that campaign should refresh the existing filter for building dataset

string

The campaign sign-off policy.

array of objects

The list of supervisors identified for the campaign.

supervisors
boolean

Allow escalation to the supervisors.

string

Campaign configuration id

string

Campaign configuration rev

boolean
array of objects
whitelist
array of objects
blacklist
Responses

500

Server error

Language
URL
Choose an example:
application/json