Automated commit 'ISCCOMPLI-651: Deprecated sod beta endpoints (#1475)

* ISCCOMPLI-651: deperceated sod beta endpoints' by github action: 6748155352
sailpoint-oss · Nov 3, 2023 · e648330 · e648330
1 parent 2e1491b
commit e648330
Show file tree

Hide file tree

Showing 13 changed files with 63 additions and 39 deletions.
diff --git a/idn/beta/paths/sod-all-report-run.yaml b/idn/beta/paths/sod-all-report-run.yaml
@@ -1,10 +1,11 @@
 post:
-  operationId: runSodAllPoliciesForOrg
+  operationId: startSodAllPoliciesForOrg
   tags:
     - SOD Policy
   summary: Runs all policies for org
-  # security:
-  #   - oauth2: [ORG_ADMIN]
+  deprecated: true
+  security:
+    - UserContextAuth: [idn:sod-violation:write]
   description: >-
     Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy.
     If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.

diff --git a/idn/beta/paths/sod-all-report-status.yaml b/idn/beta/paths/sod-all-report-status.yaml
@@ -3,6 +3,9 @@ get:
   tags:
     - SOD Policy
   summary: Get multi-report run task status
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-violation:read ]
   description: >-
     This endpoint gets the status for a violation report for all policy run.
 

diff --git a/idn/beta/paths/sod-download-custom-report.yaml b/idn/beta/paths/sod-download-custom-report.yaml
@@ -1,14 +1,15 @@
 get:
-  operationId: downloadCustomViolationReport
+  operationId: getCustomViolationReport
   tags:
     - SOD Policy
   summary: Download custom violation report
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-violation:read ]
   description: >-
     This allows to download a specified named violation report for a given report reference.
 
     Requires role of ORG_ADMIN.
-  # security:
-  #   - oauth2: [ORG_ADMIN]
   parameters:
     - in: path
       name: reportResultId

diff --git a/idn/beta/paths/sod-download-default-report.yaml b/idn/beta/paths/sod-download-default-report.yaml
@@ -1,14 +1,15 @@
 get:
-  operationId: downloadDefaultViolationReport
+  operationId: getDefaultViolationReport
   tags:
     - SOD Policy
   summary: Download violation report
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-violation:read ]
   description: >-
     This allows to download a violation report for a given report reference.
 
     Requires role of ORG_ADMIN.
-  # security:
-  #   - oauth2: [ORG_ADMIN]
   parameters:
     - in: path
       name: reportResultId

diff --git a/idn/beta/paths/sod-policies.yaml b/idn/beta/paths/sod-policies.yaml
@@ -3,6 +3,9 @@ post:
   tags:
     - SOD Policy
   summary: Create SOD policy
+  deprecated: true
+  security:
+    - UserContextAuth: [idn:sod-policy:write]
   description: >-
     This creates both General and Conflicting Access Based policy, with a limit
     of 50 entitlements for each (left & right) criteria for Conflicting Access
@@ -232,6 +235,9 @@ get:
   tags:
     - SOD Policy
   summary: List SOD policies
+  deprecated: true
+  security:
+    - UserContextAuth: [idn:sod-policy:read]
   description: >-
     This gets list of all SOD policies.
 

diff --git a/idn/beta/paths/sod-policy.yaml b/idn/beta/paths/sod-policy.yaml
@@ -3,12 +3,13 @@ get:
   tags:
     - SOD Policy
   summary: Get SOD policy by ID
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-policy:read ]
   description: >-
     This gets specified SOD policy.
 
     Requires role of ORG_ADMIN.
-  # security:
-  #   - oauth2: [ORG_ADMIN]
   parameters:
     - in: path
       name: id
@@ -126,12 +127,13 @@ get:
     '500':
       $ref: '../../v3/responses/500.yaml'
 put:
-  operationId: updateSodPolicy
+  operationId: putSodPolicy
   tags:
     - SOD Policy
   summary: Update SOD policy by ID
-  # security:
-  #   - oauth2: [ORG_ADMIN]
+  deprecated: true
+  security:
+    - UserContextAuth: [idn:sod-policy:write]
   description: >-
     This updates a specified SOD policy.
 
@@ -351,8 +353,9 @@ delete:
   tags:
     - SOD Policy
   summary: Delete SOD policy by ID
-  # security:
-  #   - oauth2: [ORG_ADMIN]
+  deprecated: true
+  security:
+    - UserContextAuth: [idn:sod-policy:write]
   description: >-
     This deletes a specified SOD policy.
 
@@ -372,6 +375,7 @@ delete:
         default: true
       description: Indicates whether this is a soft delete (logical true) or a hard delete.
       required: false
+      example: true
   responses:
     '204':
       description: No content.
@@ -392,16 +396,15 @@ patch:
   tags:
     - SOD Policy
   summary: Patch a SOD policy
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-policy:write ]
   description: >-
     Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
   
     Requires role of ORG_ADMIN.
 
-    This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. 
-
-  # security:
-  #   - oauth2: [ORG_ADMIN]
-
+    This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
   parameters:
     - in: path
       name: id

diff --git a/idn/beta/paths/sod-report-run.yaml b/idn/beta/paths/sod-report-run.yaml
@@ -1,10 +1,11 @@
 post:
-  operationId: runSodPolicy
+  operationId: startSodPolicy
   tags:
     - SOD Policy
   summary: Runs SOD policy violation report
-  # security:
-  #   - oauth2: [ORG_ADMIN]
+  deprecated: true
+  security:
+    - UserContextAuth: [idn:sod-violation:write]
   description: >-
     This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with
     violation limit exceeded message.

diff --git a/idn/beta/paths/sod-schedule.yaml b/idn/beta/paths/sod-schedule.yaml
@@ -3,12 +3,13 @@ get:
   tags:
     - SOD Policy
   summary: Get SOD policy schedule
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-policy:read ]
   description: >-
     This endpoint gets a specified SOD policy's schedule.
 
     Requires the role of ORG_ADMIN.
-  # security:
-  #   - oauth2: [ORG_ADMIN]
   parameters:
     - in: path
       name: id
@@ -35,12 +36,13 @@ get:
     '500':
       $ref: '../../v3/responses/500.yaml'
 put:
-  operationId: updatePolicySchedule
+  operationId: putPolicySchedule
   tags:
     - SOD Policy
   summary: Update SOD Policy schedule
-  # security:
-  #   - oauth2: [ORG_ADMIN]
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-policy:write ]
   description: >-
     This updates schedule for a specified SOD policy.
 
@@ -81,8 +83,9 @@ delete:
   tags:
     - SOD Policy
   summary: Delete SOD policy schedule
-  # security:
-  #   - oauth2: [ORG_ADMIN]
+  deprecated: true
+  security:
+    - UserContextAuth: [idn:sod-policy:write]
   description: >-
     This deletes schedule for a specified SOD policy.
 

diff --git a/idn/beta/paths/sod-violation-report-status.yaml b/idn/beta/paths/sod-violation-report-status.yaml
@@ -3,12 +3,13 @@ get:
   tags:
     - SOD Policy
   summary: Get violation report run status
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-violation:read ]
   description: >-
     This gets the status for a violation report run task that has already been invoked.
 
     Requires role of ORG_ADMIN.
-  # security:
-  #   - oauth2: [ORG_ADMIN]
   parameters:
     - in: path
       name: reportResultId

diff --git a/idn/beta/paths/sod-violation-report.yaml b/idn/beta/paths/sod-violation-report.yaml
@@ -3,12 +3,13 @@ get:
   tags:
     - SOD Policy
   summary: Get SOD violation report status
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-violation:read ]
   description: >-
     This gets the status for a violation report run task that has already been invoked.
 
     Requires role of ORG_ADMIN.
-  # security:
-  #   - oauth2: [ORG_ADMIN]
   parameters:
     - in: path
       name: id

diff --git a/idn/beta/paths/sod/predict-violations.yaml b/idn/beta/paths/sod/predict-violations.yaml
@@ -1,8 +1,11 @@
 post:
-  operationId: predictSodViolations
+  operationId: startPredictSodViolations
   tags:
     - SOD Violations
-  summary: Predict SOD violations for the given identity if they were granted the given access.
+  summary: Predict SOD violations for identity.
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:sod-violation:read ]
   description: >-
     This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies.
     Returns the violations that would be caused.

diff --git a/idn/v3/paths/sod-policy.yaml b/idn/v3/paths/sod-policy.yaml
@@ -128,7 +128,7 @@ get:
 put:
   security:
     - UserContextAuth: [idn:sod-policy:write]
-  operationId: setSodPolicy
+  operationId: putSodPolicy
   tags:
     - SOD Policy
   summary: Update SOD policy by ID

diff --git a/idn/v3/paths/sod-schedule.yaml b/idn/v3/paths/sod-schedule.yaml
@@ -35,7 +35,7 @@ get:
 put:
   security:
     - UserContextAuth: [idn:sod-policy:write]
-  operationId: setPolicySchedule
+  operationId: putPolicySchedule
   tags:
     - SOD Policy
   summary: Update SOD Policy schedule