Skip to content

Commit

Permalink
Apply automatic changes
Browse files Browse the repository at this point in the history
  • Loading branch information
tyler-mairose-sp authored and github-actions[bot] committed Aug 6, 2024
1 parent d4c7673 commit dc511ed
Show file tree
Hide file tree
Showing 7 changed files with 9,069 additions and 8,932 deletions.
111 changes: 61 additions & 50 deletions dereferenced/deref-sailpoint-api.beta.json

Large diffs are not rendered by default.

175 changes: 121 additions & 54 deletions dereferenced/deref-sailpoint-api.beta.yaml

Large diffs are not rendered by default.

98 changes: 49 additions & 49 deletions dereferenced/deref-sailpoint-api.v3.json

Large diffs are not rendered by default.

161 changes: 110 additions & 51 deletions dereferenced/deref-sailpoint-api.v3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24119,11 +24119,16 @@ paths:
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'
- 'idn:campaign-report:read'
- 'idn:campaign-report:manage'
parameters:
- in: query
name: detail
Expand Down Expand Up @@ -25092,10 +25097,13 @@ paths:
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'
- 'idn:campaign:manage'
requestBody:
required: true
content:
Expand Down Expand Up @@ -26236,7 +26244,10 @@ paths:
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'
Expand Down Expand Up @@ -27096,11 +27107,14 @@ paths:
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'
- 'idn:campaign:manage'
parameters:
- in: path
name: id
Expand Down Expand Up @@ -27672,12 +27686,15 @@ paths:
post:
security:
- UserContextAuth:
- 'idn:certification:write'
- '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 Expand Up @@ -28133,9 +28150,10 @@ paths:
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'
Expand Down Expand Up @@ -28487,10 +28505,10 @@ paths:
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'
- 'idn:campaign:manage'
requestBody:
description: 'Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE'
required: false
Expand Down Expand Up @@ -28830,10 +28848,13 @@ paths:
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'
- 'idn:campaign:manage'
requestBody:
description: IDs of the campaigns to delete.
required: true
Expand Down Expand Up @@ -29165,12 +29186,13 @@ paths:
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'
- 'idn:campaign-report:manage'
parameters:
- in: path
name: id
Expand Down Expand Up @@ -29494,12 +29516,14 @@ paths:
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'
- 'idn:campaign-report:manage'
parameters:
- in: path
name: id
Expand Down Expand Up @@ -29883,12 +29907,13 @@ paths:
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'
- 'idn:campaign-report:manage'
parameters:
- in: path
name: id
Expand Down Expand Up @@ -30225,12 +30250,14 @@ paths:
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'
- 'idn:campaign:read'
- 'idn:campaign:manage'
responses:
'200':
description: Campaign report configuration.
Expand Down Expand Up @@ -30483,12 +30510,13 @@ paths:
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'
- 'idn:campaign:manage'
requestBody:
required: true
description: Campaign report configuration.
Expand Down Expand Up @@ -32774,10 +32802,13 @@ paths:
tags:
- Certification Campaigns
summary: Create a Campaign Template
description: Use this API to create a certification campaign template based on campaign.
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'
- 'idn:campaign-template:manage'
requestBody:
required: true
content:
Expand Down Expand Up @@ -34114,12 +34145,16 @@ paths:
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'
- 'idn:campaign-template:read'
- 'idn:campaign-template:manage'
parameters:
- in: query
name: limit
Expand Down Expand Up @@ -35010,10 +35045,13 @@ paths:
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'
- 'idn:campaign-template:manage'
parameters:
- in: path
name: id
Expand Down Expand Up @@ -36002,10 +36040,14 @@ paths:
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'
- 'idn:campaign-template:manage'
parameters:
- in: path
name: id
Expand Down Expand Up @@ -36922,10 +36964,13 @@ paths:
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'
- 'idn:campaign-template:manage'
parameters:
- in: path
name: id
Expand Down Expand Up @@ -37245,10 +37290,12 @@ paths:
tags:
- Certification Campaigns
summary: Get Campaign Template Schedule
description: Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
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
Expand Down Expand Up @@ -37731,10 +37778,12 @@ paths:
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
Expand Down Expand Up @@ -38285,10 +38334,12 @@ paths:
tags:
- Certification Campaigns
summary: Delete Campaign Template Schedule
description: Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
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
Expand Down Expand Up @@ -38610,13 +38661,21 @@ paths:
summary: Generate a Campaign from Template
security:
- UserContextAuth:
- 'idn:campaign-template:run'
description: |-
- '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 fields that determine the generated campaign's name/description. Placeholders in those fields are formatted with the current date and time upon generation.
Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a campaign called "Campaign for 2020" (assuming the year at generation time is 2020).

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

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

Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](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
Expand Down
Loading

0 comments on commit dc511ed

Please sign in to comment.