NextGenerationCertificationCampaignsApi
This API is flagged as Experimental while we are in the process of migrating from the Legacy Certifications Engine to the Next Generation Certifications Engine. This endpoint resolves only campaigns generated on the Next Generation Certifications Engine. While we do not anticipate major changes, this API will remain in this state until we have completed the full migration of the Legacy Platform to the Next Generation Certifications Engine.
Certification Campaign Filters
Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify.
For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters.
For more information about creating a campaign filter, refer to Creating a Campaign Filter
You can create campaign filters using any of the following criteria types:
-
Access Profile : This criteria type includes or excludes access profiles from a campaign.
-
Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute.
-
Entitlement : This criteria type includes or excludes entitlements from a campaign.
-
Identity : This criteria type includes or excludes specific identities from your campaign.
-
Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen.
-
Role : This criteria type includes or excludes roles, as opposed to identities.
-
Source : This criteria type includes or excludes entitlements from a source you select.
For more information about these criteria types, refer to Types of Campaign Filters
Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter.
For example, an inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification.
Certification Campaigns
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.
-
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.
Certification Summaries
Use this API to implement certification summary functionality. With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. Implementing certification summary functionality improves organizations' ability to review their certifications and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes.
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 as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more.
Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected.
Certifications
Use this API to implement certification functionality. With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory 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 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 as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more.
Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively.
When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and 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 select '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.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| complete-gov-certification-campaign-v1 | POST /certification-campaigns/v1/campaigns/{id}/complete | Complete a Campaign |
| create-campaign-from-template-v1 | POST /certification-campaigns/v1/campaign-templates/{id}/generate | Generate campaign from template |
| create-gov-certification-campaign-filter-v1 | POST /certification-campaigns/v1/campaign-filters | Create a Campaign Filter |
| create-gov-certification-campaign-template-v1 | POST /certification-campaigns/v1/campaign-templates | Create a Campaign Template. |
| create-gov-certification-campaign-v1 | POST /certification-campaigns/v1/campaigns | Create a campaign |
| create-report-v1 | POST /certification-campaigns/v1/campaigns/{campaignId}/reports | Create campaign report |
| delete-gov-certification-campaign-filters-v1 | POST /certification-campaigns/v1/campaign-filters/delete | Deletes Campaign Filters |
| delete-gov-certification-campaign-template-schedule-v1 | DELETE /certification-campaigns/v1/campaign-templates/{id}/schedule | Delete a Campaign Template Schedule |
| delete-gov-certification-campaign-template-v1 | DELETE /certification-campaigns/v1/campaign-templates/{id} | Delete a Campaign Template |
| delete-gov-certification-campaigns-v1 | POST /certification-campaigns/v1/campaigns/delete | Delete Campaigns |
| get-access-summaries-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/access-summaries/{type} | Access Summaries |
| get-certification-entitlement-children-details-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/review-items/{reviewItemId}/entitlements/{entitlementId}/children | Entitlement Children in a Certification |
| get-certification-entitlement-details-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/review-items/{reviewItemId}/entitlements/{entitlementId} | Get Entitlement in a Certification |
| get-certification-entitlement-parents-details-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/review-items/{reviewItemId}/entitlements/{entitlementId}/parents | Entitlement Parents in a Certification |
| get-certification-entitlement-permissions-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/review-items/{reviewItemId}/entitlements/{entitlementId}/permissions | Permissions in a Certification |
| get-certification-item-account-details-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/review-items/{reviewItemId}/item-id/{entitlementId}/cert-account-details | Certification Item Account Details |
| get-certification-v1 | GET /certification-campaigns/v1/certifications/{certificationId} | Certification by ID |
| get-decision-summary-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/decision-summary | Summary of Certification Decisions |
| get-download-url-v1 | GET /certification-campaigns/v1/campaigns/{campaignId}/reports/{reportId}/download-url | Download URL for campaign report |
| get-gov-certification-access-profile-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/review-items/{reviewItemId}/access-profiles/{accessProfileId} | Get an Access Profile |
| get-gov-certification-campaign-filter-by-id-v1 | GET /certification-campaigns/v1/campaign-filters/{id} | Get Campaign Filter by ID |
| get-gov-certification-campaign-report-v1 | GET /certification-campaigns/v1/campaigns/{campaignId}/reports/{reportId} | Get a campaign report |
| get-gov-certification-campaign-template-schedule-v1 | GET /certification-campaigns/v1/campaign-templates/{id}/schedule | Get a Campaign Template Schedule |
| get-gov-certification-campaign-template-v1 | GET /certification-campaigns/v1/campaign-templates/{id} | Get a Campaign Template |
| get-gov-certification-campaign-v1 | GET /certification-campaigns/v1/campaigns/{id} | Get a campaign |
| get-gov-certification-task-v1 | GET /certification-campaigns/v1/certification-tasks/{id} | Task details by ID |
| get-pending-tasks-v1 | GET /certification-campaigns/v1/certification-tasks | List of Pending Tasks |
| get-status-summary-v1 | GET /certification-campaigns/v1/certifications/status-summary | Status Summary For Certifications |
| get-subject-summary-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/subject-summary/{subjectId} | Summary for a Certification Subject |
| list-campaign-templates-v1 | GET /certification-campaigns/v1/campaign-templates | List Campaign Templates |
| list-campaigns-v1 | GET /certification-campaigns/v1/campaigns | List the campaigns |
| list-certifications-v1 | GET /certification-campaigns/v1/certifications | List Certifications |
| list-gov-certification-campaign-filters-v1 | GET /certification-campaigns/v1/campaign-filters | List Campaign Filters |
| list-gov-certification-reviewers-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/reviewers | List of Reviewers for certification |
| list-reports-v1 | GET /certification-campaigns/v1/campaigns/{campaignId}/reports | List reports for a campaign |
| list-review-items-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/review-items | List of Review Items |
| list-subject-summaries-v1 | GET /certification-campaigns/v1/certifications/{certificationId}/subject-summaries | Subject Summaries for a Certification |
| move-certifications-v1 | POST /certification-campaigns/v1/campaigns/{campaignId}/reassign | Reassign certifications to an identity |
| move-subject-and-items-async-v1 | POST /certification-campaigns/v1/certifications/{certificationId}/reassign-async | Reassign certification items asynchronously |
| move-subject-and-items-v1 | POST /certification-campaigns/v1/certifications/{certificationId}/reassign | Reassign certification subjects or items |
| patch-campaign-v1 | PATCH /certification-campaigns/v1/campaigns/{id} | Update a campaign |
| patch-gov-certification-campaign-template-v1 | PATCH /certification-campaigns/v1/campaign-templates/{id} | Update a Campaign Template |
| process-sign-off-certification-v1 | POST /certification-campaigns/v1/certifications/{certificationId}/sign-off | Finalize Certification Decisions |
| put-campaign-filter-v1 | PUT /certification-campaigns/v1/campaign-filters/{id} | Updates a Campaign Filter |
| search-campaign-templates-v1 | POST /certification-campaigns/v1/campaign-templates/search | Search campaign templates |
| search-certifications-v1 | POST /certification-campaigns/v1/certifications/search | Search Certifications |
| search-insights-access-summary-v1 | POST /certification-campaigns/v1/insights/access-summary | Get Insights Access Summary |
| search-review-items-v1 | POST /certification-campaigns/v1/certifications/{certificationId}/review-items/search | Search certification review items |
| search-subject-summaries-v1 | POST /certification-campaigns/v1/certifications/{certificationId}/subject-summaries/search | Search certification subject summaries |
| set-or-update-campaign-template-schedule-v1 | PUT /certification-campaigns/v1/campaign-templates/{id}/schedule | Set a campaign template schedule |
| start-gov-certification-campaign-v1 | POST /certification-campaigns/v1/campaigns/{id}/activate | Activate a Campaign |
| submit-decisions-v1 | POST /certification-campaigns/v1/certifications/{certificationId}/decide | Decide on a Certification Item |
complete-gov-certification-campaign-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Complete a Campaign
This endpoint will run successfully for any campaigns that are past due. This endpoint will return a bad request error if the campaign is not past due.
Completes a certification campaign. This is provided to admins so that they can complete a certification even if all items have not been completed. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The campaign id | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| completeCampaignOptions | CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless we specify explicitly REVOKE in autoCompleteAction | [optional] |
Return type
object
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { CompleteCampaignOptions } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The campaign id
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const completeCampaignOptions: CompleteCampaignOptions = {
"autoCompleteAction" : "REVOKE"
}; // Optional. Default behavior is for the campaign to auto-approve upon completion, unless we specify explicitly REVOKE in autoCompleteAction (optional)
const result = await apiInstance.completeGovCertificationCampaignV1({ id: id });
console.log(result);
create-campaign-from-template-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Generate campaign from template Generates a new campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields in order to 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" will insert the current year; a campaign template named "Campaign for %y" would generate 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. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The desired campaign template's ID. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignGet
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918083-5d19-1a86-a15d-28455b4a2329; // The desired campaign template\'s ID.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createCampaignFromTemplateV1({ id: id });
console.log(result);
create-gov-certification-campaign-filter-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Create a Campaign Filter Create a campaign filter based on filter details and criteria. Required roles are ORG_ADMIN or CERT_ADMIN. The request body must not exceed 1 MiB (1,048,576 bytes); larger requests are rejected with a 400 response.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignFilterCreate | CampaignFilterCreate | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignFilterGet
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { CampaignFilterCreate } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignFilterCreate: CampaignFilterCreate = {
"mode" : "INCLUSION",
"name" : "Identity Attribute Campaign Filter",
"description" : "Campaign filter to certify data based on specified property of Identity Attribute.",
"criteriaList" : [ {
"criteriaType" : "IDENTITY",
"criteriaProperty" : "DISPLAY_NAME",
"criteriaValue" : "support",
"operation" : "EQUALS"
} ]
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createGovCertificationCampaignFilterV1({ campaignFilterCreate: campaignFilterCreate });
console.log(result);
create-gov-certification-campaign-template-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Create a Campaign Template. Creates campaign template based on campaign. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignTemplateCreate | CampaignTemplateCreate | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignTemplateGet
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { CampaignTemplateCreate } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignTemplateCreate: CampaignTemplateCreate = {
"recommendationsEnabled" : true,
"sunsetCommentsRequired" : true,
"deadlineDuration" : "P2W",
"searchBasedParams" : {
"identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ],
"searchType" : "ACCESS",
"query" : "admin",
"accessConstraints" : [ {
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
"type" : "ENTITLEMENT",
"operator" : "SELECTED"
}, {
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
"type" : "ENTITLEMENT",
"operator" : "SELECTED"
} ]
},
"description" : "Template for the annual manager campaign.",
"reviewer" : {
"name" : "William Wilson",
"id" : "0fbe863c063c4c88a35fd7f17e8a3df5",
"type" : "IDENTITY"
},
"type" : "IDENTITY",
"filterRef" : {
"id" : "e9f9a139-7b84-2fd5-a658-42087040d3ac"
},
"emailNotificationEnabled" : false,
"remediatorRef" : {
"name" : "Role Admin",
"id" : "2c90ad2a70ace7d50170acf22ca90010"
},
"autoRevokeAllowed" : false,
"name" : "Manager Campaign Template",
"mandatoryCommentRequirement" : "NO_DECISIONS",
"campaignDescription" : "Everyone needs to be reviewed by their manager",
"campaignName" : "Manager Campaign",
"sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ]
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createGovCertificationCampaignTemplateV1({ campaignTemplateCreate: campaignTemplateCreate });
console.log(result);
create-gov-certification-campaign-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Create a campaign Creates a new Certification Campaign with the information provided in the request body. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignCreate | CampaignCreate | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignGet
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { CampaignCreate } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignCreate: CampaignCreate = {
"inlineFilter" : {
"mode" : "INCLUSION",
"criteriaList" : [ {
"criteriaType" : "IDENTITY",
"criteriaProperty" : "DISPLAY_NAME",
"criteriaValue" : "support",
"operation" : "EQUALS"
} ]
},
"recommendationsEnabled" : true,
"sunsetCommentsRequired" : true,
"searchBasedParams" : {
"identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ],
"searchType" : "ACCESS",
"query" : "admin",
"accessConstraints" : [ {
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
"type" : "ENTITLEMENT",
"operator" : "SELECTED"
}, {
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
"type" : "ENTITLEMENT",
"operator" : "SELECTED"
} ]
},
"description" : "Everyone needs to be reviewed by their manager",
"reviewer" : {
"name" : "William Wilson",
"id" : "0fbe863c063c4c88a35fd7f17e8a3df5",
"type" : "IDENTITY"
},
"autoActivate" : true,
"type" : "IDENTITY",
"filterRef" : {
"id" : "e9f9a139-7b84-2fd5-a658-42087040d3ac"
},
"emailNotificationEnabled" : false,
"remediatorRef" : {
"name" : "Role Admin",
"id" : "2c90ad2a70ace7d50170acf22ca90010"
},
"autoRevokeAllowed" : false,
"name" : "Manager Campaign",
"mandatoryCommentRequirement" : "NO_DECISIONS",
"deadlineTimezone" : "-05:00",
"deadline" : "2020-03-15",
"sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ]
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createGovCertificationCampaignV1({ campaignCreate: campaignCreate });
console.log(result);
create-report-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Create campaign report Creates a new campaign report asynchronously for the provided campaignId. Required roles are ORG_ADMIN or CERT_ADMIN or REPORT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignId | string | The ID of the campaign to generate a report for | [default to undefined] |
| triggerCampaignReportRequest | TriggerCampaignReportRequest | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignReport
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { TriggerCampaignReportRequest } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignId: string = e1aeb0b6-0021-4f40-8bc7-5c56533214b3; // The ID of the campaign to generate a report for
const triggerCampaignReportRequest: TriggerCampaignReportRequest = {
"format" : "PDF",
"name" : "My Campaign Report",
"type" : "REMEDIATION"
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createReportV1({ campaignId: campaignId, triggerCampaignReportRequest: triggerCampaignReportRequest });
console.log(result);
delete-gov-certification-campaign-filters-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Deletes Campaign Filters Deletes campaign filters whose IDs are specified in the provided list of campaign filter IDs. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| requestBody | Array<string> | A JSON list of IDs of campaign filters to delete. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
(empty response body)
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const requestBody: Array<string> = ; // A JSON list of IDs of campaign filters to delete.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.deleteGovCertificationCampaignFiltersV1({ requestBody: requestBody });
console.log(result);
delete-gov-certification-campaign-template-schedule-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Delete a Campaign Template Schedule Deletes a schedule by campaign template ID. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The ID of the campaign template whose schedule is being deleted. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
(empty response body)
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918083-5d19-1a86-a15d-28455b4a2329; // The ID of the campaign template whose schedule is being deleted.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.deleteGovCertificationCampaignTemplateScheduleV1({ id: id });
console.log(result);
delete-gov-certification-campaign-template-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Delete a Campaign Template Deletes a campaign template by ID. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The ID of the campaign template being deleted. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
(empty response body)
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918083-5d19-1a86-a15d-28455b4a2329; // The ID of the campaign template being deleted.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.deleteGovCertificationCampaignTemplateV1({ id: id });
console.log(result);
delete-gov-certification-campaigns-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Delete Campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignsDeleteRequest | CampaignsDeleteRequest | IDs of the campaigns to delete. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
object
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { CampaignsDeleteRequest } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignsDeleteRequest: CampaignsDeleteRequest = {
"ids" : [ "ef38f943-47e9-4562-b5bb-8424a56397d8", "ef38f943-47e9-4562-b5bb-8424a56397d9" ]
}; // IDs of the campaigns to delete.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.deleteGovCertificationCampaignsV1({ campaignsDeleteRequest: campaignsDeleteRequest });
console.log(result);
get-access-summaries-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Access Summaries This API returns a list of access summaries for the specified certification and type. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| type | CertificationItemType | The type of review item to retrieve summaries for | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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: completed: eq, ne targetReference.id: eq, ne, in targetReference.name: eq, sw, co sourceName: eq, sw, co | [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: targetReference.name | [optional] [default to undefined] |
Return type
Array<ReviewData>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const type: CertificationItemType = ACCESS_PROFILE; // The type of review item to retrieve summaries for
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 = completed eq false and sourceName sw 'AD'; // 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: **completed**: *eq, ne* **targetReference.id**: *eq, ne, in* **targetReference.name**: *eq, sw, co* **sourceName**: *eq, sw, co* (optional)
const sorters: string = targetReference.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: **targetReference.name** (optional)
const result = await apiInstance.getAccessSummariesV1({ certificationId: certificationId, type: type });
console.log(result);
get-certification-entitlement-children-details-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Entitlement Children in a Certification Returns a list of child entitlements for the provided entitlement, as long as the logged-in user is a reviewer of the specified certification, and the certification contains either the specified entitlement, or an access profile that contains the specified entitlement. ORG_ADMIN or CERT_ADMIN can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| reviewItemId | string | The certification item ID | [default to undefined] |
| entitlementId | string | The entitlement ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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, in, sw type: eq, in attribute: eq, in value: eq, in, sw source.id: eq, in requestable: eq created: gt, lt, ge, le modified: gt, lt, ge, le | [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: id, name, created, modified, type, attribute, value, source.id | [optional] [default to undefined] |
Return type
Array<PassThroughEntitlement>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const reviewItemId: string = 2478b87b-f0d2-4585-b42d-45e4d580c5cf; // The certification item ID
const entitlementId: string = ef38f94347e94562b5bb8424a56397d8; // The entitlement ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 'Read Only'; // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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: **id, name, created, modified, type, attribute, value, source.id** (optional)
const result = await apiInstance.getCertificationEntitlementChildrenDetailsV1({ certificationId: certificationId, reviewItemId: reviewItemId, entitlementId: entitlementId });
console.log(result);
get-certification-entitlement-details-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get Entitlement in a Certification This API get the details for the entitlement, as long as the logged-in user is a reviewer of the specified certification, and the certification contains either the specified entitlement, or an access profile that contains the specified entitlement. ORG_ADMIN or CERT_ADMIN can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| reviewItemId | string | The certification item ID | [default to undefined] |
| entitlementId | string | The entitlement ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
PassThroughEntitlement
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const reviewItemId: string = 2478b87b-f0d2-4585-b42d-45e4d580c5cf; // The certification item ID
const entitlementId: string = ef38f94347e94562b5bb8424a56397d8; // The entitlement ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getCertificationEntitlementDetailsV1({ certificationId: certificationId, reviewItemId: reviewItemId, entitlementId: entitlementId });
console.log(result);
get-certification-entitlement-parents-details-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Entitlement Parents in a Certification Returns a list of parent entitlements for the provided entitlement, as long as the logged-in user is a reviewer of the specified certification, and the certification contains either the specified entitlement, or an access profile that contains the specified entitlement. ORG_ADMIN or CERT_ADMIN can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| reviewItemId | string | The certification item ID | [default to undefined] |
| entitlementId | string | The entitlement ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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, in, sw type: eq, in attribute: eq, in value: eq, in, sw source.id: eq, in requestable: eq created: gt, lt, ge, le modified: gt, lt, ge, le | [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: id, name, created, modified, type, attribute, value, source.id | [optional] [default to undefined] |
Return type
Array<PassThroughEntitlement>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const reviewItemId: string = 2478b87b-f0d2-4585-b42d-45e4d580c5cf; // The certification item ID
const entitlementId: string = ef38f94347e94562b5bb8424a56397d8; // The entitlement ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 = attribute eq 'role'; // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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: **id, name, created, modified, type, attribute, value, source.id** (optional)
const result = await apiInstance.getCertificationEntitlementParentsDetailsV1({ certificationId: certificationId, reviewItemId: reviewItemId, entitlementId: entitlementId });
console.log(result);
get-certification-entitlement-permissions-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Permissions in a Certification Retrieves a list of permissions associated with the given certification itemId value, as long as the logged-in user is a reviewer of the specified certification, and the certification contains either the specified entitlement, or an access profile or the role that contains the specified entitlement. ORG_ADMIN or CERT_ADMIN can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| reviewItemId | string | The certification item ID | [default to undefined] |
| entitlementId | string | The entitlement ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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] |
Return type
Array<PermissionDTO>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const reviewItemId: string = 2478b87b-f0d2-4585-b42d-45e4d580c5cf; // The certification item ID
const entitlementId: string = ef38f94347e94562b5bb8424a56397d8; // The entitlement ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 result = await apiInstance.getCertificationEntitlementPermissionsV1({ certificationId: certificationId, reviewItemId: reviewItemId, entitlementId: entitlementId });
console.log(result);
get-certification-item-account-details-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Certification Item Account Details Returns account details for a certification review item. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API. It uses the Shelby Account API to fetch details.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| reviewItemId | string | The certification item ID | [default to undefined] |
| entitlementId | string | The entitlement ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
AccountDetailsDto
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const reviewItemId: string = 2478b87b-f0d2-4585-b42d-45e4d580c5cf; // The certification item ID
const entitlementId: string = ef38f94347e94562b5bb8424a56397d8; // The entitlement ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getCertificationItemAccountDetailsV1({ certificationId: certificationId, reviewItemId: reviewItemId, entitlementId: entitlementId });
console.log(result);
get-certification-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Certification by ID This API returns a single certification by its ID. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Certification
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getCertificationV1({ certificationId: certificationId });
console.log(result);
get-decision-summary-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Summary of Certification Decisions This API returns a summary of the decisions made on a certification. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: certificationSubjectSummary.id: eq, in | [optional] [default to undefined] |
Return type
DetailedDecisionSummary
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const filters: string = certificationSubjectSummary.id in ('2c918085-71bc-fcf8-0171-c23e4b4221fc','2c918085-71bc-fcf8-0171-c23e4b4221fd'); // 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: **certificationSubjectSummary.id**: *eq, in* (optional)
const result = await apiInstance.getDecisionSummaryV1({ certificationId: certificationId });
console.log(result);
get-download-url-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Download URL for campaign report Retrieves a presigned URL to use for downloading the campaign report. Required roles are ORG_ADMIN or CERT_ADMIN or REPORT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignId | string | The ID of the campaign to be retrieved | [default to undefined] |
| reportId | string | The ID of the report to be retrieved | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignReportDownloadResponse
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignId: string = e1aeb0b6-0021-4f40-8bc7-5c56533214b3; // The ID of the campaign to be retrieved
const reportId: string = e1aeb0b6-0021-4f40-8bc7-5c56533214b3; // The ID of the report to be retrieved
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getDownloadUrlV1({ campaignId: campaignId, reportId: reportId });
console.log(result);
get-gov-certification-access-profile-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get an Access Profile This API returns an access profile details based on access profile id provided, as long as the logged-in user is a reviewer of the specified certification, and the certification contains either the specified access profile, or a role that contains the specified access profile. ORG_ADMIN or CERT_ADMIN can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| reviewItemId | string | The certification item ID. This must of review item type either ROLE or ACCESS_PROFILE. | [default to undefined] |
| accessProfileId | string | The Access Profile ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
AccessProfile2
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const reviewItemId: string = 2478b87b-f0d2-4585-b42d-45e4d580c5cf; // The certification item ID. This must of review item type either ROLE or ACCESS_PROFILE.
const accessProfileId: string = 2c9180837ca6693d017ca8d097500149; // The Access Profile ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getGovCertificationAccessProfileV1({ certificationId: certificationId, reviewItemId: reviewItemId, accessProfileId: accessProfileId });
console.log(result);
get-gov-certification-campaign-filter-by-id-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get Campaign Filter by ID Retrieves information for an existing campaign filter using the filter's ID. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The ID of the campaign filter to be retrieved. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignFilterGet
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = e9f9a139-7b84-2fd5-a658-42087040d3ac; // The ID of the campaign filter to be retrieved.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getGovCertificationCampaignFilterByIdV1({ id: id });
console.log(result);
get-gov-certification-campaign-report-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get a campaign report Retrieves the reports for an existing campaign using the campaign's ID and report ID. Required roles are ORG_ADMIN or CERT_ADMIN or REPORT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignId | string | The ID of the campaign to be retrieved | [default to undefined] |
| reportId | string | The ID of the report to be retrieved | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignReport
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignId: string = e1aeb0b6-0021-4f40-8bc7-5c56533214b3; // The ID of the campaign to be retrieved
const reportId: string = e1aeb0b6-0021-4f40-8bc7-5c56533214b3; // The ID of the report to be retrieved
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getGovCertificationCampaignReportV1({ campaignId: campaignId, reportId: reportId });
console.log(result);
get-gov-certification-campaign-template-schedule-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get a Campaign Template Schedule Fetches a schedule by a campaign template ID. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The campaign template's ID for the desired campaign template schedule. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Schedule
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918083-5d19-1a86-a15d-28455b4a2329; // The campaign template\'s ID for the desired campaign template schedule.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getGovCertificationCampaignTemplateScheduleV1({ id: id });
console.log(result);
get-gov-certification-campaign-template-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get a Campaign Template Fetches a campaign template by ID. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The desired campaign template's ID. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignTemplateGet
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918083-5d19-1a86-a15d-28455b4a2329; // The desired campaign template\'s ID.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getGovCertificationCampaignTemplateV1({ id: id });
console.log(result);
get-gov-certification-campaign-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get a campaign Retrieves information for an existing campaign using the campaign's ID. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for the certifications under this campaign can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The ID of the campaign to be retrieved | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignGet
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918085-71bc-4cf8-a171-c23e4b4221fc; // The ID of the campaign to be retrieved
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getGovCertificationCampaignV1({ id: id });
console.log(result);
get-gov-certification-task-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Task details by ID
This API returns the task for the specified ID. Required roles are ORG_ADMIN or CERT_ADMIN. If the targetType is CERTIFICATION, then the reviewers for the specified certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The task ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CertificationTask
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 63b32151-26c0-42f4-9299-8898dc1c9daa; // The task ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getGovCertificationTaskV1({ id: id });
console.log(result);
get-pending-tasks-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List of Pending Tasks
This API returns a list of pending (QUEUED or IN_PROGRESS) certification related tasks. Any authenticated token can call this API, but only tasks you are authorized to review will be returned. Non-admin users must include query parameter as reviewer-identity=me in the API call.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| reviewerIdentity | string | The ID of reviewer identity. me indicates the current user. | [optional] [default to undefined] |
| 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 targetId: eq, in type: eq, in | [optional] [default to undefined] |
Return type
Array<CertificationTask>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const reviewerIdentity: string = Ada.1de82e55078344; // The ID of reviewer identity. *me* indicates the current user. (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 = type eq "REASSIGN_SUBJECTS_AND_ITEMS"; // 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* **targetId**: *eq, in* **type**: *eq, in* (optional)
const result = await apiInstance.getPendingTasksV1({ });
console.log(result);
get-status-summary-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Status Summary For Certifications Return the status summary for certifications owned by the logged in user. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CertificationStatusSummary
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getStatusSummaryV1({ });
console.log(result);
get-subject-summary-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Summary for a Certification Subject This API returns the summary for a subject on a specified certification. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| subjectId | string | The subject summary ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CertificationSubjectSummary
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const subjectId: string = 2c918087-72a5-44f5-a172-a9540e501ba8; // The subject summary ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getSubjectSummaryV1({ certificationId: certificationId, subjectId: subjectId });
console.log(result);
list-campaign-templates-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List Campaign Templates Lists all campaign templates matching the supplied standard V3 query parameters. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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: id: eq, ne, in, gt, ge, lt, le, sw, co name: eq, ne, in, gt, ge, lt, le, sw, co | [optional] [default to undefined] |
Return type
Array<CampaignTemplateGet>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 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 "Campaign 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: **id**: *eq, ne, in, gt, ge, lt, le, sw, co* **name**: *eq, ne, in, gt, ge, lt, le, sw, co* (optional)
const result = await apiInstance.listCampaignTemplatesV1({ });
console.log(result);
list-campaigns-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List the campaigns List all the campaign details. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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, co status: eq, in, ne Possible values are [PENDING, STAGED, CANCELING, ACTIVATING, ACTIVE, COMPLETING, COMPLETED, ERROR] | [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, modified, deadline, status, totalCertifications, completedCertifications | [optional] [default to undefined] |
Return type
Array<CampaignSummary>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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, co* **status**: *eq, in, ne* Possible values are [PENDING, STAGED, CANCELING, ACTIVATING, ACTIVE, COMPLETING, COMPLETED, ERROR] (optional)
const sorters: string = name,-created; // 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, deadline, status, totalCertifications, completedCertifications** (optional)
const result = await apiInstance.listCampaignsV1({ });
console.log(result);
list-certifications-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List Certifications
This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. Non-admin users must include query parameter as ?reviewer-identity=me in the API call.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| reviewerIdentity | string | The ID of reviewer identity. me indicates the current user. | [optional] [default to undefined] |
| 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 phase: eq completed: eq campaignRef.campaignType: eq, in campaignRef.id: eq, in reviewProgress: eq, in reviewerDeleted: eq reviewerName: sw, co | [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, dueDate, dateSigned | [optional] [default to undefined] |
Return type
Array<Certification>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const reviewerIdentity: string = me; // The ID of reviewer identity. *me* indicates the current user. (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 "Bob"; // 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* **phase**: *eq* **completed**: *eq* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* **reviewProgress**: *eq, in* **reviewerDeleted**: *eq* **reviewerName**: *sw, co* (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, dueDate, dateSigned** (optional)
const result = await apiInstance.listCertificationsV1({ });
console.log(result);
list-gov-certification-campaign-filters-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List Campaign Filters Lists all Campaign Filters. Scope can be reduced via standard V3 query params. All Campaign Filters matching the query params. Required roles are ORG_ADMIN or CERT_ADMIN
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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] |
Return type
Array<CampaignFilterGet>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 result = await apiInstance.listGovCertificationCampaignFiltersV1({ });
console.log(result);
list-gov-certification-reviewers-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List of Reviewers for certification This API returns a list of reviewers for the certification. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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, co email: eq, sw, co | [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, email | [optional] [default to undefined] |
Return type
Array<IdentityReference>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 "Bob"; // 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, co* **email**: *eq, sw, co* (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, email** (optional)
const result = await apiInstance.listGovCertificationReviewersV1({ certificationId: certificationId });
console.log(result);
list-reports-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List reports for a campaign Retrieves all reports for an existing campaign using the campaign's ID. Required roles are ORG_ADMIN or CERT_ADMIN or REPORT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignId | string | The ID of the campaign to be retrieved | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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, ne, in name: eq, sw, co type: eq, in, ne Possible values are [STATUS, SIGN_OFF, COMPOSITION, REMEDIATION] format: eq, in, ne Possible values are [PDF, CSV] status: eq, in, ne Possible values are [IN_PROGRESS, FAILED, SUCCESS] | [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, type, format, created, modified | [optional] [default to undefined] |
Return type
Array<CampaignReport>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignId: string = e1aeb0b6-0021-4f40-8bc7-5c56533214b3; // The ID of the campaign to be retrieved
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 = type eq "SIGN_OFF"; // 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, ne, in* **name**: *eq, sw, co* **type**: *eq, in, ne* Possible values are [STATUS, SIGN_OFF, COMPOSITION, REMEDIATION] **format**: *eq, in, ne* Possible values are [PDF, CSV] **status**: *eq, in, ne* Possible values are [IN_PROGRESS, FAILED, SUCCESS] (optional)
const sorters: string = name,-created; // 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, type, format, created, modified** (optional)
const result = await apiInstance.listReportsV1({ campaignId: campaignId });
console.log(result);
list-review-items-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
List of Review Items This API returns a list of review items for an identity campaign certification. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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, ne, in completed: eq, ne certificationSubjectSummary.id: eq, ne, in certificationSubjectSummary.subjectName: eq, sw, co certificationSubjectSummary.subjectManagerName: eq, sw, co certificationSubjectSummary.subjectEmail: eq, sw, co certificationSubjectSummary.identityState: eq, in, ne reviewData.targetReference.id: eq, ne, in reviewData.targetReference.name: eq, sw, co reviewData.targetReference.type: eq reviewData.entitlement.provisioningType: eq, ne, in sourceName: eq, sw, co accountName: eq, sw, co reauthRequired: eq, ne | [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: certificationSubjectSummary.subjectName, certificationSubjectSummary.subjectManagerName, reviewData.targetReference.id, reviewData.targetReference.name, sourceName, accountName | [optional] [default to undefined] |
| activityData | boolean | If set to true, the response will include HTTP header "SLPT-Activity-Data-ID" which will allow the caller to query for certification items activity data in a separate call. | [optional] [default to false] |
Return type
Array<ReviewItem>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 = id eq "ef38f943-47e9-4562-b5bb-8424a56397d8"; // 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, ne, in* **completed**: *eq, ne* **certificationSubjectSummary.id**: *eq, ne, in* **certificationSubjectSummary.subjectName**: *eq, sw, co* **certificationSubjectSummary.subjectManagerName**: *eq, sw, co* **certificationSubjectSummary.subjectEmail**: *eq, sw, co* **certificationSubjectSummary.identityState**: *eq, in, ne* **reviewData.targetReference.id**: *eq, ne, in* **reviewData.targetReference.name**: *eq, sw, co* **reviewData.targetReference.type**: *eq* **reviewData.entitlement.provisioningType**: *eq, ne, in* **sourceName**: *eq, sw, co* **accountName**: *eq, sw, co* **reauthRequired**: *eq, ne* (optional)
const sorters: string = certificationSubjectSummary.subjectName; // 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: **certificationSubjectSummary.subjectName, certificationSubjectSummary.subjectManagerName, reviewData.targetReference.id, reviewData.targetReference.name, sourceName, accountName** (optional)
const activityData: boolean = false; // If set to true, the response will include HTTP header \"SLPT-Activity-Data-ID\" which will allow the caller to query for certification items activity data in a separate call. (optional)
const result = await apiInstance.listReviewItemsV1({ certificationId: certificationId });
console.log(result);
list-subject-summaries-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Subject Summaries for a Certification This API returns a list of the subject summaries for a specific certification. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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 targetId: eq, ne, in completed: eq, ne subjectName: eq, sw, co | [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: subjectName, targetDisplayName | [optional] [default to undefined] |
Return type
Array<CertificationSubjectSummary>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 = completed eq false and subjectName sw 'Derek'; // 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* **targetId**: *eq, ne, in* **completed**: *eq, ne* **subjectName**: *eq, sw, co* (optional)
const sorters: string = subjectName; // 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: **subjectName, targetDisplayName** (optional)
const result = await apiInstance.listSubjectSummariesV1({ certificationId: certificationId });
console.log(result);
move-certifications-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Reassign certifications to an identity This API reassigns the specified certifications from one identity to another. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| campaignId | string | The certification campaign ID. | [default to undefined] |
| reassignCertifications | ReassignCertifications | A non-empty array of items and identities which reviewer is going to reassign. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CertificationTask
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { ReassignCertifications } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const campaignId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification campaign ID.
const reassignCertifications: ReassignCertifications = {
"certificationIds" : [ "af385946-4779-4712-91bb-8424a563abc1", "af385946-4779-4712-91bb-8424a563abc2", "af385946-4779-4712-91bb-8424a563abc3" ],
"reason" : "Reassigning the certifications",
"reassignTo" : {
"id" : "0fbe863c-063c-4c88-a35f-d7f17e8a3df5",
"type" : "IDENTITY"
}
}; // A non-empty array of items and identities which reviewer is going to reassign.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.moveCertificationsV1({ campaignId: campaignId, reassignCertifications: reassignCertifications });
console.log(result);
move-subject-and-items-async-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Reassign certification items asynchronously This API reassigns subjects or items in an identity campaign certification to another reviewer. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The ID of the certification which we are going to reassign. | [default to undefined] |
| reassignReference | ReassignReference | A non-empty array of items and identities which reviewer is going to reassign. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CertificationTask
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { ReassignReference } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the certification which we are going to reassign.
const reassignReference: ReassignReference = {
"reason" : "Reassigning this item to the appropriate reviewer.",
"reassignTo" : "ef38f943-47e9-4562-b5bb-8424a56397d8",
"reassign" : [ {
"id" : "ef38f943-47e9-4562-b5bb-8424a56397d8",
"type" : "ITEM"
} ]
}; // A non-empty array of items and identities which reviewer is going to reassign.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.moveSubjectAndItemsAsyncV1({ certificationId: certificationId, reassignReference: reassignReference });
console.log(result);
move-subject-and-items-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Reassign certification subjects or items This API reassigns subjects or items in an identity campaign certification to another reviewer. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The ID of the certification which we are going to reassign. | [default to undefined] |
| reassignReference | ReassignReference | A non-empty array of items and identities which reviewer is going to reassign. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Certification
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { ReassignReference } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the certification which we are going to reassign.
const reassignReference: ReassignReference = {
"reason" : "Reassigning this item to the appropriate reviewer.",
"reassignTo" : "ef38f943-47e9-4562-b5bb-8424a56397d8",
"reassign" : [ {
"id" : "ef38f943-47e9-4562-b5bb-8424a56397d8",
"type" : "ITEM"
} ]
}; // A non-empty array of items and identities which reviewer is going to reassign.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.moveSubjectAndItemsV1({ certificationId: certificationId, reassignReference: reassignReference });
console.log(result);
patch-campaign-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Update a campaign Use this API to update individual fields on a certification campaign, using the JSON Patch standard. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the campaign 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 | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignGet
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { JsonPatchOperation } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // ID of the campaign being modified.
const jsonPatchOperation: Array<JsonPatchOperation> = {
"op" : "replace",
"path" : "/description",
"value" : "New 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 xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchCampaignV1({ id: id, jsonPatchOperation: jsonPatchOperation });
console.log(result);
patch-gov-certification-campaign-template-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Update a Campaign Template Allows updating individual fields on a campaign template using the JSON Patch standard. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The ID of the campaign template being modified. | [default to undefined] |
| jsonPatchOperation | Array<JsonPatchOperation> | A list of campaign template update operations according to the JSON Patch standard. The following fields are patchable: - name - description - campaignName - campaignDescription - remediatorRef - reviewer (id and type only; name is resolved server-side) - mandatoryCommentRequirement - emailNotificationEnabled - autoRevokeAllowed - recommendationsEnabled - sunsetCommentsRequired - deadlineDuration - filterRef - searchBasedParams - sourceIds | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignTemplateGet
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { JsonPatchOperation } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918083-5d19-1a86-a15d-28455b4a2329; // The ID of the campaign template being modified.
const jsonPatchOperation: Array<JsonPatchOperation> = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}; // A list of campaign template update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: - name - description - campaignName - campaignDescription - remediatorRef - reviewer (id and type only; name is resolved server-side) - mandatoryCommentRequirement - emailNotificationEnabled - autoRevokeAllowed - recommendationsEnabled - sunsetCommentsRequired - deadlineDuration - filterRef - searchBasedParams - sourceIds
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchGovCertificationCampaignTemplateV1({ id: id, jsonPatchOperation: jsonPatchOperation });
console.log(result);
process-sign-off-certification-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Finalize Certification Decisions This API finalizes all decisions made on a certification and initiates any remediations required. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Certification
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.processSignOffCertificationV1({ certificationId: certificationId });
console.log(result);
put-campaign-filter-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Updates a Campaign Filter Updates an existing campaign filter using the filter's ID. Required roles are ORG_ADMIN or CERT_ADMIN. The request body must not exceed 1 MiB (1,048,576 bytes); larger requests are rejected with a 400 response.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The ID of the campaign filter being modified. | [default to undefined] |
| campaignFilterUpdate | CampaignFilterUpdate | A campaign filter details with updated field values. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
CampaignFilterGet
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { CampaignFilterUpdate } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = e9f9a139-7b84-2fd5-a658-42087040d3ac; // The ID of the campaign filter being modified.
const campaignFilterUpdate: CampaignFilterUpdate = {
"mode" : "INCLUSION",
"name" : "Identity Attribute Campaign Filter",
"description" : "Campaign filter to certify data based on specified property of Identity Attribute.",
"criteriaList" : [ {
"criteriaType" : "IDENTITY",
"criteriaProperty" : "DISPLAY_NAME",
"criteriaValue" : "support",
"operation" : "EQUALS"
} ]
}; // A campaign filter details with updated field values.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.putCampaignFilterV1({ id: id, campaignFilterUpdate: campaignFilterUpdate });
console.log(result);
search-campaign-templates-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Search campaign templates This executes a full-text search for campaign templates using the provided search string. It matches any campaign templates that match the search terms in the name or description field of the Campaign Template itself, or the name and description of the campaign defined by the template. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchRequest | SearchRequest | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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: id: eq, ne, in, gt, ge, lt, le, sw, co name: eq, ne, in, gt, ge, lt, le, sw, co | [optional] [default to undefined] |
Return type
Array<CampaignTemplateGet>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { SearchRequest } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const searchRequest: SearchRequest = {
"queryString" : "identity 2023"
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 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 "Campaign 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: **id**: *eq, ne, in, gt, ge, lt, le, sw, co* **name**: *eq, ne, in, gt, ge, lt, le, sw, co* (optional)
const result = await apiInstance.searchCampaignTemplatesV1({ searchRequest: searchRequest });
console.log(result);
search-certifications-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Search Certifications
This API returns a list of certifications. It contains a request body with search parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. Non-admin users must include query parameter as ?reviewer-identity=me in the API call.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| reviewerIdentity | string | The ID of reviewer identity. me indicates the current user. | [optional] [default to undefined] |
| 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 phase: eq completed: eq campaignRef.campaignType: eq, in campaignRef.id: eq, in reviewProgress: eq, in reviewerDeleted: eq reviewerName: sw, co | [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, dueDate, dateSigned | [optional] [default to undefined] |
| searchRequest | SearchRequest | [optional] |
Return type
Array<Certification>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { SearchRequest } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const reviewerIdentity: string = me; // The ID of reviewer identity. *me* indicates the current user. (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 = reviewerName sw "Bob"; // 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* **phase**: *eq* **completed**: *eq* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* **reviewProgress**: *eq, in* **reviewerDeleted**: *eq* **reviewerName**: *sw, co* (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, dueDate, dateSigned** (optional)
const searchRequest: SearchRequest = {
"queryString" : "identity 2023"
}; // (optional)
const result = await apiInstance.searchCertificationsV1({ });
console.log(result);
search-insights-access-summary-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get Insights Access Summary Retrieves the scoped access based on the provided InsightDetails. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| insightDetails | InsightDetails | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<ScopedAccess>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { InsightDetails } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const insightDetails: InsightDetails = {
"campaignType" : "IDENTITY",
"identityIdFilter" : [ "2c918085718230600171993742c63558" ],
"query" : "admin",
"type" : "ENTITLEMENT"
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.searchInsightsAccessSummaryV1({ insightDetails: insightDetails });
console.log(result);
search-review-items-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Search certification review items This API returns a list of review items for an identity campaign certification. It contains a request body with search parameters. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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, ne, in completed: eq, ne certificationSubjectSummary.id: eq, ne, in certificationSubjectSummary.subjectName: eq, sw, co certificationSubjectSummary.subjectManagerName: eq, sw, co certificationSubjectSummary.subjectEmail: eq, sw, co certificationSubjectSummary.identityState: eq, in, ne reviewData.targetReference.id: eq, ne, in reviewData.targetReference.name: eq, sw, co reviewData.targetReference.type: eq reviewData.entitlement.provisioningType: eq, ne, in sourceName: eq, sw, co accountName: eq, sw, co reauthRequired: eq, ne | [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: certificationSubjectSummary.subjectName, certificationSubjectSummary.subjectManagerName, reviewData.targetReference.id, reviewData.targetReference.name, sourceName, accountName | [optional] [default to undefined] |
| activityData | boolean | If set to true, the response will include HTTP header "SLPT-Activity-Data-ID" which will allow the caller to query for certification items activity data in a separate call. | [optional] [default to false] |
| searchRequest | SearchRequest | [optional] |
Return type
Array<ReviewItem>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { SearchRequest } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 = id eq "ef38f943-47e9-4562-b5bb-8424a56397d8"; // 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, ne, in* **completed**: *eq, ne* **certificationSubjectSummary.id**: *eq, ne, in* **certificationSubjectSummary.subjectName**: *eq, sw, co* **certificationSubjectSummary.subjectManagerName**: *eq, sw, co* **certificationSubjectSummary.subjectEmail**: *eq, sw, co* **certificationSubjectSummary.identityState**: *eq, in, ne* **reviewData.targetReference.id**: *eq, ne, in* **reviewData.targetReference.name**: *eq, sw, co* **reviewData.targetReference.type**: *eq* **reviewData.entitlement.provisioningType**: *eq, ne, in* **sourceName**: *eq, sw, co* **accountName**: *eq, sw, co* **reauthRequired**: *eq, ne* (optional)
const sorters: string = certificationSubjectSummary.subjectName; // 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: **certificationSubjectSummary.subjectName, certificationSubjectSummary.subjectManagerName, reviewData.targetReference.id, reviewData.targetReference.name, sourceName, accountName** (optional)
const activityData: boolean = false; // If set to true, the response will include HTTP header \"SLPT-Activity-Data-ID\" which will allow the caller to query for certification items activity data in a separate call. (optional)
const searchRequest: SearchRequest = {
"queryString" : "identity 2023"
}; // (optional)
const result = await apiInstance.searchReviewItemsV1({ certificationId: certificationId });
console.log(result);
search-subject-summaries-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Search certification subject summaries This API returns a list of the subject summaries for a specific certification. It contains a request body with search parameters. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The certification ID | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| 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 targetId: eq, ne, in completed: eq, ne subjectName: eq, sw, co | [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: subjectName, targetDisplayName | [optional] [default to undefined] |
| searchRequest | SearchRequest | [optional] |
Return type
Array<CertificationSubjectSummary>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { SearchRequest } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The certification ID
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (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 = completed eq false and subjectName sw 'Derek'; // 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* **targetId**: *eq, ne, in* **completed**: *eq, ne* **subjectName**: *eq, sw, co* (optional)
const sorters: string = subjectName; // 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: **subjectName, targetDisplayName** (optional)
const searchRequest: SearchRequest = {
"queryString" : "identity 2023"
}; // (optional)
const result = await apiInstance.searchSubjectSummariesV1({ certificationId: certificationId });
console.log(result);
set-or-update-campaign-template-schedule-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Set a campaign template schedule Creates or replaces the schedule for a campaign template. Send the full schedule in the request body. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The ID of the campaign template whose schedule is being modified or created. | [default to undefined] |
| schedule | Schedule | The data for the schedule for the given campaign template ID. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
(empty response body)
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { Schedule } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = 2c918083-5d19-1a86-a15d-28455b4a2329; // The ID of the campaign template whose schedule is being modified or created.
const schedule: Schedule = {
"hours" : {
"values" : [ "1", "2", "3" ],
"interval" : 2,
"type" : "LIST"
},
"months" : {
"values" : [ "1", "2", "3" ],
"interval" : 2,
"type" : "LIST"
},
"timeZoneId" : "America/Chicago",
"days" : {
"values" : [ "1", "2", "3" ],
"interval" : 2,
"type" : "LIST"
},
"expiration" : "2025-09-15T16:00:00Z",
"type" : "DAILY"
}; // The data for the schedule for the given campaign template ID.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.setOrUpdateCampaignTemplateScheduleV1({ id: id, schedule: schedule });
console.log(result);
start-gov-certification-campaign-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Activate a Campaign Submits a job to activate the campaign with the given ID. The campaign must be staged. Required roles are ORG_ADMIN or CERT_ADMIN.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The campaign id | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| activateCampaignOptions | ActivateCampaignOptions | Optional. If the timezone is not specified, we will continue using the campaign's timezone, which was set during campaign creation. 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 { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { ActivateCampaignOptions } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The campaign id
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const activateCampaignOptions: ActivateCampaignOptions = {
"timeZone" : "-05:00"
}; // Optional. If the timezone is not specified, we will continue using the campaign\'s timezone, which was set during campaign creation. 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.startGovCertificationCampaignV1({ id: id });
console.log(result);
submit-decisions-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Decide on a Certification Item The API makes a decision to approve or revoke one or more certification items. Required roles are ORG_ADMIN or CERT_ADMIN. Reviewers for this certification can also call this API.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| certificationId | string | The ID of the certification on which to make decisions | [default to undefined] |
| reviewDecision | Array<ReviewDecision> | A non-empty array of decisions to be made. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Certification
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { NextGenerationCertificationCampaignsApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { ReviewDecision } from '@sailpoint/api-client/dist/gov_certification/api';
const configuration = new Configuration();
const apiInstance = new NextGenerationCertificationCampaignsApi(configuration);
const certificationId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the certification on which to make decisions
const reviewDecision: Array<ReviewDecision> = {
"comments" : "This user no longer needs access to this source",
"decision" : "APPROVED",
"proposedEndDate" : "2017-07-11T18:45:37.098Z",
"recommendation" : {
"reasons" : [ "Reason 1", "Reason 2" ],
"recommendation" : "APPROVE",
"timestamp" : "2020-06-01T13:49:37.385Z"
},
"id" : "ef38f943-47e9-4562-b5bb-8424a56397d8"
}; // A non-empty array of decisions to be made.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.submitDecisionsV1({ certificationId: certificationId, reviewDecision: reviewDecision });
console.log(result);