Skip to content

Commit

Permalink
Automated commit 'Merge pull request #1753 from sailpoint/DEVREL-1664
Browse files Browse the repository at this point in the history
Devrel 1664' by github action: 10270238089
  • Loading branch information
tyler-mairose-sp committed Aug 6, 2024
1 parent 83f9c33 commit d4c7673
Show file tree
Hide file tree
Showing 28 changed files with 172 additions and 113 deletions.
6 changes: 3 additions & 3 deletions idn/beta/paths/campaign-activate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ post:
tags:
- Certification Campaigns
summary: Activate a Campaign
description: >-
description: |
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign).
Calling this endpoint requires roles of CERT_ADMIN and ORG_ADMIN.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign:update ]
- UserContextAuth: [idn:campaign:manage]
deprecated: true
requestBody:
description:
Expand Down
9 changes: 5 additions & 4 deletions idn/beta/paths/campaign-admin-cert-reassign.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
post:
security:
- UserContextAuth: [ idn:certification:write ]
- UserContextAuth: [idn:campaign:manage]
operationId: move
tags:
- Certification Campaigns
summary: Reassign Certifications
description: >-
This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN
authority is required to call this API.
description: |
This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
parameters:
- in: path
Expand Down
4 changes: 2 additions & 2 deletions idn/beta/paths/campaign-complete.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ post:
Use this API to complete a certification campaign. This functionality is provided to admins so that they
can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign).
Calling this endpoint requires roles of CERT_ADMIN and ORG_ADMIN.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: [idn:campaign:update]
- UserContextAuth: [idn:campaign:manage]
requestBody:
description:
Optional. Default behavior is for the campaign to auto-approve upon completion,
Expand Down
12 changes: 6 additions & 6 deletions idn/beta/paths/campaign-reports-configuration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ get:
- Certification Campaigns
summary: Get Campaign Reports Configuration
deprecated: true
description: >-
description: |
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config).
Calling this endpoint requires roles of CERT_ADMIN and ORG_ADMIN.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign-reports-config:read ]
- UserContextAuth: [idn:campaign:read, idn:campaign:manage]
responses:
'200':
description: Campaign report configuration.
Expand All @@ -34,13 +34,13 @@ put:
- Certification Campaigns
summary: Set Campaign Reports Configuration
deprecated: true
description: >-
description: |
Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config).
Calling this endpoint requires roles of CERT_ADMIN and ORG_ADMIN.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign-reports-config:write ]
- UserContextAuth: [idn:campaign:manage]
requestBody:
required: true
description: Campaign report configuration.
Expand Down
6 changes: 3 additions & 3 deletions idn/beta/paths/campaign-reports.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ get:
- Certification Campaigns
summary: Get Campaign Reports
deprecated: true
description: >-
description: |
Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports).
Calling this endpoint requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [idn:campaign-report:read]
- UserContextAuth: [idn:campaign-report:read, idn:campaign-report:manage]
parameters:
- in: path
name: id
Expand Down
6 changes: 3 additions & 3 deletions idn/beta/paths/campaign-run-remediation-scan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ post:
tags:
- Certification Campaigns
summary: Run Campaign Remediation Scan
description: >-
description: |
Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan).
Calling this endpoint requires roles of CERT_ADMIN and ORG_ADMIN.
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: [idn:campaign-report:run]
- UserContextAuth: [idn:campaign-report:manage]
parameters:
- in: path
name: id
Expand Down
6 changes: 3 additions & 3 deletions idn/beta/paths/campaign-run-report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ post:
- Certification Campaigns
summary: Run Campaign Report
deprecated: true
description: >-
description: |
Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report).
Calling this endpoint requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [idn:campaign-report:run]
- UserContextAuth: [idn:campaign-report:manage]
parameters:
- in: path
name: id
Expand Down
6 changes: 3 additions & 3 deletions idn/beta/paths/campaign-template-generate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ post:
summary: Generate a Campaign from Template
deprecated: true
security:
- UserContextAuth: [idn:campaign-template:run]
description: >-
- UserContextAuth: [idn:campaign-template:manage]
description: |
Use this API to generate a new certification campaign from a campaign template.
The campaign object contained in the template has special formatting applied to its name and description
Expand All @@ -21,7 +21,7 @@ post:
Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template).
Calling this endpoint requires the ORG_ADMIN role.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
parameters:
- in: path
name: id
Expand Down
18 changes: 12 additions & 6 deletions idn/beta/paths/campaign-template-schedule.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ get:
tags:
- Certification Campaigns
summary: Get Campaign Template Schedule
description: >-
description: |
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign-template:read ]
- UserContextAuth: []
deprecated: true
parameters:
- in: path
Expand Down Expand Up @@ -42,11 +44,13 @@ put:
tags:
- Certification Campaigns
summary: Set Campaign Template Schedule
description: >-
description: |
Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign-template:run ]
- UserContextAuth: []
deprecated: true
parameters:
- in: path
Expand Down Expand Up @@ -148,10 +152,12 @@ delete:
tags:
- Certification Campaigns
summary: Delete Campaign Template Schedule
description: >-
description: |
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign-template:run ]
- UserContextAuth: []
deprecated: true
parameters:
- in: path
Expand Down
21 changes: 15 additions & 6 deletions idn/beta/paths/campaign-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ get:
tags:
- Certification Campaigns
summary: Get a Campaign Template
description: Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template).
description: |
Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign-template:read ]
- UserContextAuth: [idn:campaign-template:read, idn:campaign-template:manage]
deprecated: true
parameters:
- in: path
Expand Down Expand Up @@ -48,10 +51,13 @@ patch:
tags:
- Certification Campaigns
summary: Update a Campaign Template
description: Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template).
description: |
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: [ idn:campaign-template:update ]
- UserContextAuth: [idn:campaign-template:manage]
parameters:
- in: path
name: id
Expand Down Expand Up @@ -117,10 +123,13 @@ delete:
tags:
- Certification Campaigns
summary: Delete a Campaign Template
description: Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template).
description: |
Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: [ idn:campaign-template:delete ]
- UserContextAuth: [idn:campaign-template:manage]
parameters:
- in: path
name: id
Expand Down
13 changes: 8 additions & 5 deletions idn/beta/paths/campaign-templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ get:
tags:
- Certification Campaigns
summary: List Campaign Templates
description: >-
description: |
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates).
The endpoint returns all campaign templates matching the query parameters.
The endpoint returns all campaign templates matching the query parameters.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: [ idn:campaign-template-list:read ]
- UserContextAuth: [idn:campaign-template:read, idn:campaign-template:manage]
parameters:
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/offset.yaml'
Expand Down Expand Up @@ -69,10 +70,12 @@ post:
tags:
- Certification Campaigns
summary: Create a Campaign Template
description: >-
description: |
Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [ idn:campaign-template:create ]
- UserContextAuth: [idn:campaign-template:manage]
deprecated: true
requestBody:
required: true
Expand Down
14 changes: 9 additions & 5 deletions idn/beta/paths/campaign.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ get:
tags:
- Certification Campaigns
summary: Get Campaign
description: >-
description: |
Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign).
Authorized callers must be reviewers for this campaign, ORG_ADMINs, or a CERT_ADMINs.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: []
- UserContextAuth: [idn:campaign:read, idn:campaign:manage]
parameters:
- in: path
name: id
Expand Down Expand Up @@ -50,10 +51,13 @@ patch:
tags:
- Certification Campaigns
summary: Update a Campaign
description: Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/beta/update-campaign).
description: |
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/beta/update-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: [idn:campaign:update,idn:campaign:read]
- UserContextAuth: [idn:campaign:read,idn:campaign:manage]
parameters:
- in: path
name: id
Expand Down
7 changes: 4 additions & 3 deletions idn/beta/paths/campaigns-delete.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ post:
tags:
- Certification Campaigns
summary: Delete Campaigns
description: >-
description: |
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns).
Authorized callers must be ORG_ADMINs or CERT_ADMINs.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
deprecated: true
security:
- UserContextAuth: [idn:campaign:delete]
- UserContextAuth: [idn:campaign:manage]
requestBody:
description: IDs of the campaigns to delete.
required: true
Expand Down
14 changes: 10 additions & 4 deletions idn/beta/paths/campaigns.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ get:
tags:
- Certification Campaigns
summary: List Campaigns
description: >-
description: |
Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns).
- UserContextAuth: []
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [idn:campaign:read, idn:campaign:manage, idn:campaign-report:read, idn:campaign-report:manage]
deprecated: true
parameters:
- in: query
Expand Down Expand Up @@ -85,9 +88,12 @@ post:
tags:
- Certification Campaigns
summary: Create Campaign
description: Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign).
description: |
Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [idn:campaign:create]
- UserContextAuth: [idn:campaign:manage]
deprecated: true
requestBody:
required: true
Expand Down
4 changes: 2 additions & 2 deletions idn/v3/paths/campaign-activate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ post:
tags:
- Certification Campaigns
summary: Activate a Campaign
description: >-
description: |
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
Calling this endpoint requires roles of CERT_ADMIN and ORG_ADMIN.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
security:
- UserContextAuth: [idn:campaign:manage]
requestBody:
Expand Down
9 changes: 5 additions & 4 deletions idn/v3/paths/campaign-admin-cert-reassign.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
post:
security:
- UserContextAuth: [idn:certification:write]
- UserContextAuth: [idn:campaign:manage]
operationId: move
tags:
- Certification Campaigns
summary: Reassign Certifications
description: >-
This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN
authority is required to call this API.
description: |
This API reassigns the specified certifications from one identity to another.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
parameters:
- in: path
name: id
Expand Down
Loading

0 comments on commit d4c7673

Please sign in to comment.