Automated commit 'Merge pull request #1901 from sailpoint/DEVREL-1733

Fixed scopes and user levels' by github action: 12144862327

idn/beta/paths/json-web-key-set.yaml

@@ -22,23 +22,23 @@ get:
                   $ref: '../schemas/GetOAuthClientResponse.yaml'
             description: The set of public key data used to validate JWTs issued by Identity Security Center
             example: [
-                {
-                  "kid": "17a3558a-5ce2-4b5b-eb79-d5e0c97f78d3",
-                  "alg": "ES256",
-                  "crv": "P-256",
-                  "kty": "EC",
-                  "x": "BB59MqkWRxyWAd7by8EKKIHuumFvOWj3YFo1HtNchDM",
-                  "y": "iBLT8AtrjpLBTuj94DXG-MER94_X-zSOlTjUS5dopJc"
-                },
-                {
-                  "kid": "bbb74f7a-0411-461b-a669-3c6b8d86771f",
-                  "alg": "ES256",
-                  "crv": "P-256",
-                  "kty": "EC",
-                  "x": "xayv8a_wpsZiME1TgmBNAV9TnXv3EuvQTNvcRmwqLtc",
-                  "y": "_bz45zThN8AQx2Dd44Kk686vMJ-4X5N-YbsRzQcVhdk"
-                }
-              ]
+              {
+                "kid": "17a3558a-5ce2-4b5b-eb79-d5e0c97f78d3",
+                "alg": "ES256",
+                "crv": "P-256",
+                "kty": "EC",
+                "x": "BB59MqkWRxyWAd7by8EKKIHuumFvOWj3YFo1HtNchDM",
+                "y": "iBLT8AtrjpLBTuj94DXG-MER94_X-zSOlTjUS5dopJc"
+              },
+              {
+                "kid": "bbb74f7a-0411-461b-a669-3c6b8d86771f",
+                "alg": "ES256",
+                "crv": "P-256",
+                "kty": "EC",
+                "x": "xayv8a_wpsZiME1TgmBNAV9TnXv3EuvQTNvcRmwqLtc",
+                "y": "_bz45zThN8AQx2Dd44Kk686vMJ-4X5N-YbsRzQcVhdk"
+              }
+            ]
             required:
               - keys
     '400':

idn/beta/paths/outlier-feature-summaries.yaml

@@ -3,11 +3,10 @@ get:
   tags:
     - IAI Outliers
   summary: Get identity outlier contibuting feature summary
-  description: >-
+  description: |
     This API returns a summary of a contributing feature for an identity outlier.
-    The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object
 
-    Requires authorization scope of 'iai:outliers-management:read'
+    The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
   parameters:
     - in: path
       name: outlierFeatureId
@@ -18,7 +17,7 @@ get:
       example: "04654b66-7561-4090-94f9-abee0722a1af"
   responses:
     '200':
-      description: Succeeded. Returns selected contributing feature summary for an outlier
+      description: Succeeded. Returns selected contributing feature summary for an outlier.
       headers:
         accept-language:
           description: The locale to use for translations
@@ -41,4 +40,8 @@ get:
     '500':
       $ref: '../../v3/responses/500.yaml'
   security:
-    - userAuth: [iai:outliers-management:read]
+    - userAuth: [iai:outliers:read, iai:outliers:manage]
+    - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outlier-summaries-latest.yaml

@@ -4,22 +4,21 @@ get:
     - IAI Outliers
   summary: IAI Identity Outliers Latest Summary
   description: >-
-    This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier
-
-    Requires authorization scope of 'iai:outliers-management:read'
+    This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
   parameters:
     - name: type
       in: query
       description: Type of the identity outliers snapshot to filter on
       required: false
+      example: LOW_SIMILARITY
       schema:
         type: string
         enum:
           - LOW_SIMILARITY
           - STRUCTURAL
   responses:
     '200':
-      description: Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers 
+      description: Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. 
       content:
         application/json:
           schema:
@@ -38,3 +37,9 @@ get:
       $ref: '../../v3/responses/429.yaml'
     '500':
       $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [iai:outliers:read, iai:outliers:manage]
+    - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outlier-summaries.yaml

@@ -4,16 +4,15 @@ get:
     - IAI Outliers
   summary: IAI Identity Outliers Summary
   description: >-
-    This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier
-
-    Requires authorization scope of 'iai:outliers-management:read'
+    This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
     - name: type
       in: query
       description: Type of the identity outliers snapshot to filter on
       required: false
+      example: LOW_SIMILARITY
       schema:
         type: string
         enum:
@@ -32,6 +31,7 @@ get:
         
         **snapshotDate**: *ge, le*
       example: snapshotDate ge "2022-02-07T20:13:29.356648026Z"
+      required: false
     - in: query
       name: sorters
       schema:
@@ -46,7 +46,7 @@ get:
       required: false
   responses:
     '200':
-      description: Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers 
+      description: Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. 
       headers:
         X-Total-Count:
           description: The total result count.
@@ -70,3 +70,9 @@ get:
       $ref: '../../v3/responses/429.yaml'
     '500':
       $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [iai:outliers:read, iai:outliers:manage]
+    - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outliers-contributing-feature-access-items.yaml

@@ -3,11 +3,10 @@ get:
   tags:
     - IAI Outliers
   summary: Gets a list of access items associated with each identity outlier contributing feature
-  description: >-
-    This API returns a list of the enriched access items associated with each feature filtered by the access item type 
-    The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare
+  description: |
+    This API returns a list of the enriched access items associated with each feature filtered by the access item type.
 
-    Requires authorization scope of 'iai:outliers-management:read'
+    The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
@@ -38,7 +37,7 @@ get:
       required: false
       schema:
         type: string
-      description: The type of access item for the identity outlier contributing feature. If not provided, it returns all
+      description: The type of access item for the identity outlier contributing feature. If not provided, it returns all.
       example: ENTITLEMENT
     - in: query
       name: sorters
@@ -74,4 +73,8 @@ get:
     '500':
       $ref: '../../v3/responses/500.yaml'
   security:
-    - userAuth: [ iai:outliers-management:read ]
+    - userAuth: [iai:outliers:read, iai:outliers:manage]
+    - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outliers-contributing-features.yaml

@@ -3,11 +3,10 @@ get:
   tags:
     - IAI Outliers
   summary: Get identity outlier's contibuting features
-  description: >-
+  description: |
     This API returns a list of contributing feature objects for a single outlier.
-    The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object
 
-    Requires authorization scope of 'iai:outliers-management:read'
+    The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
@@ -40,7 +39,7 @@ get:
         Sorting is supported for the following fields: **importance**
   responses:
     '200':
-      description: Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature
+      description: Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature.
       headers:
         X-Total-Count:
           description: The total result count.
@@ -68,3 +67,9 @@ get:
       $ref: '../../v3/responses/429.yaml'
     '500':
       $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [iai:outliers:read, iai:outliers:manage]
+    - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outliers-export.yaml

@@ -3,24 +3,24 @@ get:
   tags:
     - IAI Outliers
   summary: IAI Identity Outliers Export
-  description: >-
-    This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported
-    Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes)
+  description: |
+    This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported.
 
-    Requires authorization scope of 'iai:outliers-management:read'
+    Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
   parameters:
     - name: type
       in: query
       description: Type of the identity outliers snapshot to filter on
       required: false
+      example: LOW_SIMILARITY
       schema:
         type: string
         enum:
           - LOW_SIMILARITY
           - STRUCTURAL
   responses:
     '200':
-      description: Succeeded. Returns zip of 2 CSVs to download. 1 CSV for ignored outliers and 1 for non-ignored outliers
+      description: Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers.
       content:
         application/zip:
           schema:
@@ -36,3 +36,9 @@ get:
       $ref: '../../v3/responses/429.yaml'
     '500':
       $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [iai:outliers:read, iai:outliers:manage]
+    - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outliers-ignore.yaml

@@ -4,19 +4,17 @@ post:
     - IAI Outliers
   summary: IAI Identity Outliers Ignore
   description: >-
-    This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful.
-
-    Requires authorization scope of 'iai:outliers-management:update'
+    This API receives a list of identity IDs in the request, changes the outliers to be ignored.
   requestBody:
-      required: true
-      content:
-        application/json:
-          schema:
-            type: array
-            items:
-              type: string  
-            description: List of identity IDs to ignore from outlier listing
-            example: ['abc123def456', 'ghi789jkl012']
+    required: true
+    content:
+      application/json:
+        schema:
+          type: array
+          items:
+            type: string  
+          description: List of identity IDs to ignore from outlier listing
+          example: ['897ef96559df40e1baa6bae6b53e7340', '2c918085837fbfb4018384420dac60c3']
   responses:
     '204':
       $ref: '../../v3/responses/204.yaml'
@@ -30,3 +28,9 @@ post:
       $ref: '../../v3/responses/429.yaml'
     '500':
       $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [iai:outliers:manage]
+    - applicationAuth: [iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outliers-unignore.yaml

@@ -4,19 +4,17 @@ post:
     - IAI Outliers
   summary: IAI Identity Outliers Unignore
   description: >-
-    This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful.
-
-    Requires authorization scope of 'iai:outliers-management:update'
+    This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
   requestBody:
-      required: true
-      content:
-        application/json:
-          schema:
-            type: array
-            items:
-              type: string  
-            description: List of identity IDs to un-ignore from outlier listing
-            example: ['abc123def456', 'ghi789jkl012']
+    required: true
+    content:
+      application/json:
+        schema:
+          type: array
+          items:
+            type: string  
+          description: List of identity IDs to un-ignore from outlier listing
+          example: ['897ef96559df40e1baa6bae6b53e7340', '2c918085837fbfb4018384420dac60c3']
   responses:
     '204':
       $ref: '../../v3/responses/204.yaml'
@@ -30,3 +28,9 @@ post:
       $ref: '../../v3/responses/429.yaml'
     '500':
       $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [iai:outliers:manage]
+    - applicationAuth: [iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN

idn/beta/paths/outliers.yaml

@@ -4,9 +4,7 @@ get:
     - IAI Outliers
   summary: IAI Get Identity Outliers
   description: >-
-    This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information
-
-    Requires authorization scope of 'iai:outliers-management:read'
+    This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
@@ -61,7 +59,7 @@ get:
       example: attributes.displayName,firstDetectionDate,-score
   responses:
     '200':
-      description: Succeeded. Returns list of objects. Each object contains information about outliers
+      description: Succeeded. Returns list of objects. Each object contains information about outliers.
       headers:
         X-Total-Count:
           description: The total result count.
@@ -83,3 +81,9 @@ get:
       $ref: '../../v3/responses/429.yaml'
     '500':
       $ref: '../../v3/responses/500.yaml'
+  security:
+    - userAuth: [iai:outliers:read, iai:outliers:manage]
+    - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - REPORT_ADMIN