From d4c767382a74d250769901d4e5a18ecd9e3b20c0 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 6 Aug 2024 16:19:48 +0000 Subject: [PATCH] Automated commit 'Merge pull request #1753 from sailpoint/DEVREL-1664 Devrel 1664' by github action: 10270238089 --- idn/beta/paths/campaign-activate.yaml | 6 +++--- .../paths/campaign-admin-cert-reassign.yaml | 9 ++++---- idn/beta/paths/campaign-complete.yaml | 4 ++-- .../paths/campaign-reports-configuration.yaml | 12 +++++------ idn/beta/paths/campaign-reports.yaml | 6 +++--- .../paths/campaign-run-remediation-scan.yaml | 6 +++--- idn/beta/paths/campaign-run-report.yaml | 6 +++--- .../paths/campaign-template-generate.yaml | 6 +++--- .../paths/campaign-template-schedule.yaml | 18 ++++++++++------ idn/beta/paths/campaign-template.yaml | 21 +++++++++++++------ idn/beta/paths/campaign-templates.yaml | 13 +++++++----- idn/beta/paths/campaign.yaml | 14 ++++++++----- idn/beta/paths/campaigns-delete.yaml | 7 ++++--- idn/beta/paths/campaigns.yaml | 14 +++++++++---- idn/v3/paths/campaign-activate.yaml | 4 ++-- .../paths/campaign-admin-cert-reassign.yaml | 9 ++++---- idn/v3/paths/campaign-complete.yaml | 4 ++-- .../paths/campaign-reports-configuration.yaml | 12 +++++------ idn/v3/paths/campaign-reports.yaml | 6 +++--- .../paths/campaign-run-remediation-scan.yaml | 6 +++--- idn/v3/paths/campaign-run-report.yaml | 6 +++--- idn/v3/paths/campaign-template-generate.yaml | 6 +++--- idn/v3/paths/campaign-template-schedule.yaml | 20 +++++++++++------- idn/v3/paths/campaign-template.yaml | 21 +++++++++++++------ idn/v3/paths/campaign-templates.yaml | 11 ++++++---- idn/v3/paths/campaign.yaml | 14 ++++++++----- idn/v3/paths/campaigns-delete.yaml | 9 ++++---- idn/v3/paths/campaigns.yaml | 15 ++++++++----- 28 files changed, 172 insertions(+), 113 deletions(-) diff --git a/idn/beta/paths/campaign-activate.yaml b/idn/beta/paths/campaign-activate.yaml index 06f8626d..4a137590 100644 --- a/idn/beta/paths/campaign-activate.yaml +++ b/idn/beta/paths/campaign-activate.yaml @@ -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: diff --git a/idn/beta/paths/campaign-admin-cert-reassign.yaml b/idn/beta/paths/campaign-admin-cert-reassign.yaml index 02b8add8..da3952cf 100644 --- a/idn/beta/paths/campaign-admin-cert-reassign.yaml +++ b/idn/beta/paths/campaign-admin-cert-reassign.yaml @@ -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 diff --git a/idn/beta/paths/campaign-complete.yaml b/idn/beta/paths/campaign-complete.yaml index be445861..6e9009ff 100644 --- a/idn/beta/paths/campaign-complete.yaml +++ b/idn/beta/paths/campaign-complete.yaml @@ -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, diff --git a/idn/beta/paths/campaign-reports-configuration.yaml b/idn/beta/paths/campaign-reports-configuration.yaml index e0842408..235ce92f 100644 --- a/idn/beta/paths/campaign-reports-configuration.yaml +++ b/idn/beta/paths/campaign-reports-configuration.yaml @@ -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. @@ -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. diff --git a/idn/beta/paths/campaign-reports.yaml b/idn/beta/paths/campaign-reports.yaml index ea07e5f7..0644aa8c 100644 --- a/idn/beta/paths/campaign-reports.yaml +++ b/idn/beta/paths/campaign-reports.yaml @@ -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 diff --git a/idn/beta/paths/campaign-run-remediation-scan.yaml b/idn/beta/paths/campaign-run-remediation-scan.yaml index 45b76cec..07a0ee4b 100644 --- a/idn/beta/paths/campaign-run-remediation-scan.yaml +++ b/idn/beta/paths/campaign-run-remediation-scan.yaml @@ -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 diff --git a/idn/beta/paths/campaign-run-report.yaml b/idn/beta/paths/campaign-run-report.yaml index ea400e2e..ada46b2b 100644 --- a/idn/beta/paths/campaign-run-report.yaml +++ b/idn/beta/paths/campaign-run-report.yaml @@ -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 diff --git a/idn/beta/paths/campaign-template-generate.yaml b/idn/beta/paths/campaign-template-generate.yaml index 32388a63..2d3137b0 100644 --- a/idn/beta/paths/campaign-template-generate.yaml +++ b/idn/beta/paths/campaign-template-generate.yaml @@ -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 @@ -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 diff --git a/idn/beta/paths/campaign-template-schedule.yaml b/idn/beta/paths/campaign-template-schedule.yaml index a2bd24e4..6210f2fc 100644 --- a/idn/beta/paths/campaign-template-schedule.yaml +++ b/idn/beta/paths/campaign-template-schedule.yaml @@ -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 @@ -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 @@ -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 diff --git a/idn/beta/paths/campaign-template.yaml b/idn/beta/paths/campaign-template.yaml index c6f68858..cef9627d 100644 --- a/idn/beta/paths/campaign-template.yaml +++ b/idn/beta/paths/campaign-template.yaml @@ -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 @@ -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 @@ -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 diff --git a/idn/beta/paths/campaign-templates.yaml b/idn/beta/paths/campaign-templates.yaml index 45417d55..461aedf4 100644 --- a/idn/beta/paths/campaign-templates.yaml +++ b/idn/beta/paths/campaign-templates.yaml @@ -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' @@ -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 diff --git a/idn/beta/paths/campaign.yaml b/idn/beta/paths/campaign.yaml index 3103d194..6c718738 100644 --- a/idn/beta/paths/campaign.yaml +++ b/idn/beta/paths/campaign.yaml @@ -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 @@ -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 diff --git a/idn/beta/paths/campaigns-delete.yaml b/idn/beta/paths/campaigns-delete.yaml index 7309a1a9..a4ca025a 100644 --- a/idn/beta/paths/campaigns-delete.yaml +++ b/idn/beta/paths/campaigns-delete.yaml @@ -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 diff --git a/idn/beta/paths/campaigns.yaml b/idn/beta/paths/campaigns.yaml index 315b7f07..275ccf4e 100644 --- a/idn/beta/paths/campaigns.yaml +++ b/idn/beta/paths/campaigns.yaml @@ -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 @@ -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 diff --git a/idn/v3/paths/campaign-activate.yaml b/idn/v3/paths/campaign-activate.yaml index c8d336db..3d3571ca 100644 --- a/idn/v3/paths/campaign-activate.yaml +++ b/idn/v3/paths/campaign-activate.yaml @@ -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: diff --git a/idn/v3/paths/campaign-admin-cert-reassign.yaml b/idn/v3/paths/campaign-admin-cert-reassign.yaml index f65693b3..b1c40bfe 100644 --- a/idn/v3/paths/campaign-admin-cert-reassign.yaml +++ b/idn/v3/paths/campaign-admin-cert-reassign.yaml @@ -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 diff --git a/idn/v3/paths/campaign-complete.yaml b/idn/v3/paths/campaign-complete.yaml index 18bd8d46..b2e24da5 100644 --- a/idn/v3/paths/campaign-complete.yaml +++ b/idn/v3/paths/campaign-complete.yaml @@ -15,9 +15,9 @@ 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. - 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] requestBody: description: Optional. Default behavior is for the campaign to auto-approve upon completion, diff --git a/idn/v3/paths/campaign-reports-configuration.yaml b/idn/v3/paths/campaign-reports-configuration.yaml index e22688a8..8533eb1a 100644 --- a/idn/v3/paths/campaign-reports-configuration.yaml +++ b/idn/v3/paths/campaign-reports-configuration.yaml @@ -3,13 +3,13 @@ get: tags: - Certification Campaigns summary: Get Campaign Reports Configuration - 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. - 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. @@ -32,13 +32,13 @@ put: tags: - Certification Campaigns summary: Set Campaign Reports Configuration - description: >- + description: | Use this API to overwrite the configuration for campaign reports. - 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. diff --git a/idn/v3/paths/campaign-reports.yaml b/idn/v3/paths/campaign-reports.yaml index 7169d2d0..41b99216 100644 --- a/idn/v3/paths/campaign-reports.yaml +++ b/idn/v3/paths/campaign-reports.yaml @@ -3,12 +3,12 @@ get: tags: - Certification Campaigns summary: Get Campaign Reports - description: >- + description: | Use this API to fetch all reports for a certification campaign by campaign ID. - 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 diff --git a/idn/v3/paths/campaign-run-remediation-scan.yaml b/idn/v3/paths/campaign-run-remediation-scan.yaml index ef130d4a..c7682bce 100644 --- a/idn/v3/paths/campaign-run-remediation-scan.yaml +++ b/idn/v3/paths/campaign-run-remediation-scan.yaml @@ -3,12 +3,12 @@ post: tags: - Certification Campaigns summary: Run Campaign Remediation Scan - description: >- + description: | Use this API to run a remediation scan task for a certification campaign. - 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. security: - - UserContextAuth: [idn:campaign-report:run] + - UserContextAuth: [idn:campaign-report:manage] parameters: - in: path name: id diff --git a/idn/v3/paths/campaign-run-report.yaml b/idn/v3/paths/campaign-run-report.yaml index c8f5377f..e6a38c18 100644 --- a/idn/v3/paths/campaign-run-report.yaml +++ b/idn/v3/paths/campaign-run-report.yaml @@ -3,12 +3,12 @@ post: tags: - Certification Campaigns summary: Run Campaign Report - description: >- + description: | Use this API to run a report for a certification campaign. - 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 diff --git a/idn/v3/paths/campaign-template-generate.yaml b/idn/v3/paths/campaign-template-generate.yaml index 7b6c66fc..33a03421 100644 --- a/idn/v3/paths/campaign-template-generate.yaml +++ b/idn/v3/paths/campaign-template-generate.yaml @@ -4,8 +4,8 @@ post: - Certification Campaigns summary: Generate a Campaign from Template 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 @@ -18,7 +18,7 @@ post: Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - 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 diff --git a/idn/v3/paths/campaign-template-schedule.yaml b/idn/v3/paths/campaign-template-schedule.yaml index 72b72325..c85fac1f 100644 --- a/idn/v3/paths/campaign-template-schedule.yaml +++ b/idn/v3/paths/campaign-template-schedule.yaml @@ -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. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [ idn:campaign-template:read ] + - UserContextAuth: [] parameters: - in: path name: id @@ -41,10 +43,12 @@ put: tags: - Certification Campaigns summary: Set Campaign Template Schedule - 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. + 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. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [ idn:campaign-template:run ] + - UserContextAuth: [] parameters: - in: path name: id @@ -145,10 +149,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. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [ idn:campaign-template:run ] + - UserContextAuth: [] parameters: - in: path name: id diff --git a/idn/v3/paths/campaign-template.yaml b/idn/v3/paths/campaign-template.yaml index b4b31346..ba722985 100644 --- a/idn/v3/paths/campaign-template.yaml +++ b/idn/v3/paths/campaign-template.yaml @@ -3,9 +3,12 @@ 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. + description: | + Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [ idn:campaign-template:update ] + - UserContextAuth: [idn:campaign-template:manage] parameters: - in: path name: id @@ -71,9 +74,12 @@ get: tags: - Certification Campaigns summary: Get a Campaign Template - description: Use this API to fetch a certification campaign template by ID. + description: | + Use this API to fetch a certification campaign template by ID. + + 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] parameters: - in: path name: id @@ -115,9 +121,12 @@ delete: tags: - Certification Campaigns summary: Delete a Campaign Template - description: Use this API to delete a certification campaign template by ID. + description: | + Use this API to delete a certification campaign template by ID. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [ idn:campaign-template:delete ] + - UserContextAuth: [idn:campaign-template:manage] parameters: - in: path name: id diff --git a/idn/v3/paths/campaign-templates.yaml b/idn/v3/paths/campaign-templates.yaml index ffd23a89..f287ff11 100644 --- a/idn/v3/paths/campaign-templates.yaml +++ b/idn/v3/paths/campaign-templates.yaml @@ -3,10 +3,12 @@ post: tags: - Certification Campaigns summary: Create a Campaign Template - description: >- + description: | Use this API to create a certification campaign template based on campaign. + + 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] requestBody: required: true content: @@ -53,13 +55,14 @@ 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. The API returns all campaign templates matching the query parameters. + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [ idn:campaign-template-list:read ] + - UserContextAuth: [idn:campaign-template:read, idn:campaign-template:manage] parameters: - $ref: '../parameters/limit.yaml' - $ref: '../parameters/offset.yaml' diff --git a/idn/v3/paths/campaign.yaml b/idn/v3/paths/campaign.yaml index ca8520a0..9acc746a 100644 --- a/idn/v3/paths/campaign.yaml +++ b/idn/v3/paths/campaign.yaml @@ -3,9 +3,10 @@ get: tags: - Certification Campaigns summary: Get Campaign - description: >- - Use this API to get information for an existing certification campaign by the campaign's ID. - Authorized callers must be reviewers for this campaign, ORG_ADMINs, or a CERT_ADMINs. + description: | + Use this API to get information for an existing certification campaign by the campaign's ID. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - UserContextAuth: [idn:campaign:read, idn:campaign:manage] parameters: @@ -62,9 +63,12 @@ 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. + description: | + Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [idn:campaign:update,idn:campaign:read] + - UserContextAuth: [idn:campaign:read, idn:campaign:manage] parameters: - in: path name: id diff --git a/idn/v3/paths/campaigns-delete.yaml b/idn/v3/paths/campaigns-delete.yaml index 840c4292..8b4f49a9 100644 --- a/idn/v3/paths/campaigns-delete.yaml +++ b/idn/v3/paths/campaigns-delete.yaml @@ -3,11 +3,12 @@ post: tags: - Certification Campaigns summary: Delete Campaigns - description: >- - Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - Authorized callers must be ORG_ADMINs or CERT_ADMINs. + description: | + Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [idn:campaign:delete] + - UserContextAuth: [idn:campaign:manage] requestBody: description: IDs of the campaigns to delete. required: true diff --git a/idn/v3/paths/campaigns.yaml b/idn/v3/paths/campaigns.yaml index 4cf8be73..0cefcbeb 100644 --- a/idn/v3/paths/campaigns.yaml +++ b/idn/v3/paths/campaigns.yaml @@ -3,10 +3,12 @@ get: tags: - Certification Campaigns summary: List Campaigns - description: >- - Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + description: | + Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + 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] + - UserContextAuth: [idn:campaign:read, idn:campaign:manage, idn:campaign-report:read, idn:campaign-report:manage] parameters: - in: query name: detail @@ -84,9 +86,12 @@ post: tags: - Certification Campaigns summary: Create a campaign - description: Use this API to create a certification campaign with the information provided in the request body. + description: | + Use this API to create a certification campaign with the information provided in the request body. + + A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - - UserContextAuth: [idn:campaign:create] + - UserContextAuth: [idn:campaign:manage] requestBody: required: true content: