CertificationCampaignsApi

Use this API to implement certification campaign functionality. With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements.

A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. These certifications serve as a way of showing that a user's access has been reviewed and approved. Multiple certifications by different reviewers are often required to approve a user's access. A set of multiple certifications is called a certification campaign.

For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more.

Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns:

You can create these types of campaigns without using any search queries in Identity Security Cloud:

• ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. You only need to provide a name and description to create one.

• Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. You only need to provide a name and description to create one. You can specify the sources whose owners you want involved or just run it across all sources.

For more information about these campaign types, refer to Starting a Manager or Source Owner Campaign.

One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified.

You can use Identity Security Cloud search queries to create these types of campaigns:

• Identities: Use this campaign type to review and revoke access items for specific identities. You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign.

• Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign.

• Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign.

• Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. You can use this campaign type to view all the uncorrelated accounts for a source and certify them.

For more information about search-based campaigns, refer to Starting a Campaign from Search.

Once you have generated your campaign, it becomes available for preview. An administrator can review the campaign and make changes, or if it's ready and accurate, activate it.

Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed).

When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment.

Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items.

Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. In this situation, the certification campaign completes once all the remediation requests are completed.

The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision.

For more information about certifications and certification campaigns, refer to Certifications.

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
complete-campaign-v1	POST /campaigns/v1/{id}/complete	Complete a campaign
create-campaign-template-v1	POST /campaign-templates/v1	Create a campaign template
create-campaign-v1	POST /campaigns/v1	Create a campaign
delete-campaign-template-schedule-v1	DELETE /campaign-templates/v1/{id}/schedule	Delete campaign template schedule
delete-campaign-template-v1	DELETE /campaign-templates/v1/{id}	Delete a campaign template
delete-campaigns-v1	POST /campaigns/v1/delete	Delete campaigns
get-active-campaigns-v1	GET /campaigns/v1	List campaigns
get-campaign-reports-config-v1	GET /campaigns/v1/reports-configuration	Get campaign reports configuration
get-campaign-reports-v1	GET /campaigns/v1/{id}/reports	Get campaign reports
get-campaign-template-schedule-v1	GET /campaign-templates/v1/{id}/schedule	Get campaign template schedule
get-campaign-template-v1	GET /campaign-templates/v1/{id}	Get a campaign template
get-campaign-templates-v1	GET /campaign-templates/v1	List campaign templates
get-campaign-v1	GET /campaigns/v1/{id}	Get campaign
move-v1	POST /campaigns/v1/{id}/reassign	Reassign certifications
patch-campaign-template-v1	PATCH /campaign-templates/v1/{id}	Update a campaign template
set-campaign-reports-config-v1	PUT /campaigns/v1/reports-configuration	Set campaign reports configuration
set-campaign-template-schedule-v1	PUT /campaign-templates/v1/{id}/schedule	Set campaign template schedule
start-campaign-remediation-scan-v1	POST /campaigns/v1/{id}/run-remediation-scan	Run campaign remediation scan
start-campaign-report-v1	POST /campaigns/v1/{id}/run-report/{type}	Run campaign report
start-campaign-v1	POST /campaigns/v1/{id}/activate	Activate a campaign
start-generate-campaign-template-v1	POST /campaign-templates/v1/{id}/generate	Generate a campaign from template
update-campaign-v1	PATCH /campaigns/v1/{id}	Update a campaign

complete-campaign-v1

Complete a campaign

caution

This endpoint will run successfully for any campaigns that are past due.

This endpoint will return a content error if the campaign is not past due.

Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Campaign ID.	[default to undefined]
campaigncompleteoptions	Campaigncompleteoptions	Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE	[optional]

Return type

object

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // Campaign ID.
const campaigncompleteoptions: Campaigncompleteoptions = ; // Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional)
const result = await apiInstance.completeCampaignV1({ id: id });
console.log(result);

[Back to top]

create-campaign-template-v1

Create a campaign template Use this API to create a certification campaign template based on campaign.

API Spec

Parameters

Name	Type	Description	Notes
campaigntemplate	Campaigntemplate

Return type

Campaigntemplate

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const campaigntemplate: Campaigntemplate = ; // 
const result = await apiInstance.createCampaignTemplateV1({ campaigntemplate: campaigntemplate });
console.log(result);

[Back to top]

create-campaign-v1

Create a campaign Use this API to create a certification campaign with the information provided in the request body.

API Spec

Parameters

Name	Type	Description	Notes
campaign2	Campaign2

Return type

Campaign2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const campaign2: Campaign2 = ; // 
const result = await apiInstance.createCampaignV1({ campaign2: campaign2 });
console.log(result);

[Back to top]

delete-campaign-template-schedule-v1

Delete campaign template schedule Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign template whose schedule is being deleted.	[default to undefined]

Return type

(empty response body)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 04bedce387bd47b2ae1f86eb0bb36dee; // ID of the campaign template whose schedule is being deleted.
const result = await apiInstance.deleteCampaignTemplateScheduleV1({ id: id });
console.log(result);

[Back to top]

delete-campaign-template-v1

Delete a campaign template Use this API to delete a certification campaign template by ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign template being deleted.	[default to undefined]

Return type

(empty response body)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c9180835d191a86015d28455b4a2329; // ID of the campaign template being deleted.
const result = await apiInstance.deleteCampaignTemplateV1({ id: id });
console.log(result);

[Back to top]

delete-campaigns-v1

Delete campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.

API Spec

Parameters

Name	Type	Description	Notes
campaignsdeleterequest	Campaignsdeleterequest	IDs of the campaigns to delete.

Return type

object

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const campaignsdeleterequest: Campaignsdeleterequest = ; // IDs of the campaigns to delete.
const result = await apiInstance.deleteCampaignsV1({ campaignsdeleterequest: campaignsdeleterequest });
console.log(result);

[Back to top]

get-active-campaigns-v1

List campaigns Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.

API Spec

Parameters

Name	Type	Description	Notes
detail	`'SLIM'	'FULL'`	Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
limit	number	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	number	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
count	boolean	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq, sw status: eq, in	[optional] [default to undefined]
sorters	string	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created	[optional] [default to undefined]

Return type

Array<GetActiveCampaignsV1200ResponseInner>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const detail: string = FULL; // Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const filters: string = name eq "Manager Campaign"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, sw*  **status**: *eq, in* (optional)
const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name, created** (optional)
const result = await apiInstance.getActiveCampaignsV1({  });
console.log(result);

[Back to top]

get-campaign-reports-config-v1

Get campaign reports configuration Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

Campaignreportsconfig

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const result = await apiInstance.getCampaignReportsConfigV1({  });
console.log(result);

[Back to top]

get-campaign-reports-v1

Get campaign reports Use this API to fetch all reports for a certification campaign by campaign ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign whose reports are being fetched.	[default to undefined]

Return type

Array<Campaignreport>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign whose reports are being fetched.
const result = await apiInstance.getCampaignReportsV1({ id: id });
console.log(result);

[Back to top]

get-campaign-template-schedule-v1

Get campaign template schedule Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign template whose schedule is being fetched.	[default to undefined]

Return type

Schedule2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 04bedce387bd47b2ae1f86eb0bb36dee; // ID of the campaign template whose schedule is being fetched.
const result = await apiInstance.getCampaignTemplateScheduleV1({ id: id });
console.log(result);

[Back to top]

get-campaign-template-v1

Get a campaign template Use this API to fetch a certification campaign template by ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Requested campaign template's ID.	[default to undefined]

Return type

Campaigntemplate

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c9180835d191a86015d28455b4a2329; // Requested campaign template\'s ID.
const result = await apiInstance.getCampaignTemplateV1({ id: id });
console.log(result);

[Back to top]

get-campaign-templates-v1

List campaign templates Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.

The API returns all campaign templates matching the query parameters.

API Spec

Parameters

Name	Type	Description	Notes
limit	number	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	number	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
count	boolean	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
sorters	string	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created, modified	[optional] [default to undefined]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: eq, ge, gt, in, le, lt, ne, sw id: eq, ge, gt, in, le, lt, ne, sw	[optional] [default to undefined]

Return type

Array<Campaigntemplate>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name, created, modified** (optional)
const filters: string = name eq "manager template"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **name**: *eq, ge, gt, in, le, lt, ne, sw*  **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional)
const result = await apiInstance.getCampaignTemplatesV1({  });
console.log(result);

[Back to top]

get-campaign-v1

Get campaign Use this API to get information for an existing certification campaign by the campaign's ID.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign to be retrieved.	[default to undefined]
detail	`'SLIM'	'FULL'`	Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.

Return type

GetCampaignV1200Response

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign to be retrieved.
const detail: string = FULL; // Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
const result = await apiInstance.getCampaignV1({ id: id });
console.log(result);

[Back to top]

move-v1

Reassign certifications This API reassigns the specified certifications from one identity to another.

API Spec

Parameters

Name	Type	Description	Notes
id	string	The certification campaign ID	[default to undefined]
adminreviewreassign	Adminreviewreassign

Return type

Certificationtask

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // The certification campaign ID
const adminreviewreassign: Adminreviewreassign = ; // 
const result = await apiInstance.moveV1({ id: id, adminreviewreassign: adminreviewreassign });
console.log(result);

[Back to top]

patch-campaign-template-v1

Update a campaign template Use this API to update individual fields on a certification campaign template, using the JSON Patch standard.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign template being modified.	[default to undefined]
jsonpatchoperation	Array<Jsonpatchoperation>	A list of campaign update operations according to the JSON Patch standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)

Return type

Campaigntemplate

HTTP request headers

• Content-Type: application/json-patch+json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c9180835d191a86015d28455b4a2329; // ID of the campaign template being modified.
const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/campaign/filter/id","value":"ff80818155fe8c080155fe8d925b0316"}]; // A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.  The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) 
const result = await apiInstance.patchCampaignTemplateV1({ id: id, jsonpatchoperation: jsonpatchoperation });
console.log(result);

[Back to top]

set-campaign-reports-config-v1

Set campaign reports configuration Use this API to overwrite the configuration for campaign reports.

API Spec

Parameters

Name	Type	Description	Notes
campaignreportsconfig	Campaignreportsconfig	Campaign report configuration.

Return type

Campaignreportsconfig

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const campaignreportsconfig: Campaignreportsconfig = ; // Campaign report configuration.
const result = await apiInstance.setCampaignReportsConfigV1({ campaignreportsconfig: campaignreportsconfig });
console.log(result);

[Back to top]

set-campaign-template-schedule-v1

Set campaign template schedule Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign template being scheduled.	[default to undefined]
schedule2	Schedule2		[optional]

Return type

(empty response body)

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 04bedce387bd47b2ae1f86eb0bb36dee; // ID of the campaign template being scheduled.
const schedule2: Schedule2 = {"type":"MONTHLY","hours":{"type":"LIST","values":["17"]},"days":{"type":"LIST","values":["15"]}}; //  (optional)
const result = await apiInstance.setCampaignTemplateScheduleV1({ id: id });
console.log(result);

[Back to top]

start-campaign-remediation-scan-v1

Run campaign remediation scan Use this API to run a remediation scan task for a certification campaign.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign the remediation scan is being run for.	[default to undefined]

Return type

object

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign the remediation scan is being run for.
const result = await apiInstance.startCampaignRemediationScanV1({ id: id });
console.log(result);

[Back to top]

start-campaign-report-v1

Run campaign report Use this API to run a report for a certification campaign.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign the report is being run for.	[default to undefined]
type	Reporttype	Type of the report to run.	[default to undefined]

Return type

object

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign the report is being run for.
const type: Reporttype = ; // Type of the report to run.
const result = await apiInstance.startCampaignReportV1({ id: id, type: type });
console.log(result);

[Back to top]

start-campaign-v1

Activate a campaign Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Campaign ID.	[default to undefined]
activatecampaignoptions	Activatecampaignoptions	Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.	[optional]

Return type

object

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // Campaign ID.
const activatecampaignoptions: Activatecampaignoptions = ; // Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional)
const result = await apiInstance.startCampaignV1({ id: id });
console.log(result);

[Back to top]

start-generate-campaign-template-v1

Generate a campaign from template Use this API to generate a new certification campaign from a campaign template.

The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign's name/description. Placeholders in those fields are formatted with the current date and time upon generation.

Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a campaign called "Campaign for 2020" (assuming the year at generation time is 2020).

Valid placeholders are the date/time conversion suffix characters supported by java.util.Formatter.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign template to use for generation.	[default to undefined]

Return type

Campaignreference

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c9180835d191a86015d28455b4a2329; // ID of the campaign template to use for generation.
const result = await apiInstance.startGenerateCampaignTemplateV1({ id: id });
console.log(result);

[Back to top]

update-campaign-v1

Update a campaign Use this API to update individual fields on a certification campaign, using the JSON Patch standard.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the campaign template being modified.	[default to undefined]
jsonpatchoperation	Array<Jsonpatchoperation>	A list of campaign update operations according to the JSON Patch standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the STAGED status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the ACTIVE status, you can patch these fields: * deadline

Return type

Slimcampaign

HTTP request headers

• Content-Type: application/json-patch+json
• Accept: application/json

Example

import { CertificationCampaignsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new CertificationCampaignsApi(configuration);
const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign template being modified.
const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"replace","path":"/name","value":"This field has been updated!"},{"op":"copy","from":"/name","path":"/description"}]; // A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign.  When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed  When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline 
const result = await apiInstance.updateCampaignV1({ id: id, jsonpatchoperation: jsonpatchoperation });
console.log(result);

[Back to top]