Updates the campaign configuration for a specified campaign configuration from the specific tenant.

The API is used to update the campaign configuration for a specified campaign configuration from the specific tenant.
The administrator managing a specified tenant can update a campaign configuration created for that tenant.
The owners of the application can update a campaign configuration that is created by them or includes at least one application owned by them.
Entitlements required: tenantadmin [Tenant Administrator].

Path Params
string
required

Campaign Configuration ID

Body Params

Campaign configuration update request 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 that 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.
- userFilter: It is set to filter the list of included or excluded users or groups for certification.


In case of user entitlement campaign, you can either specify userConditionSet or userInclusionList or userExclusionList in userFilter.

- 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: Frequency of campaign instance.
- 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.
- continuousCampaignMetaData: Details of continuous campaign.
- 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

The list of Applications certified by the campaign.

applications*
object

List of Users or Groups to be included or exluded or filter for users allowed for the certification

object

Rest representation for an entitlement or entitlement condition set filter.

date-time

The start date of the first instance of campaign.

int64

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

object

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

boolean

The flag indicating the campaign occurs one-time and needs to be started immediately.

date-time

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 indicating that the campaign is in preview mode and not open to reviewers.

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

The Reviewer identifer for the campaign.

boolean
Headers
boolean
required

If the value is set to true, the API call is treated as an admin API call.

Responses

500

Your operation can't be processed because an internal server error occurred.

Language
URL
Choose an example:
application/json