From f7c8bd561468faa902f040005a080d210e4df20e Mon Sep 17 00:00:00 2001
From: GitHub Action Bot <tyler.mairose@sailpoint.com>
Date: Tue, 3 Dec 2024 17:21:55 +0000
Subject: [PATCH] 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 | 34 ++---
idn/beta/paths/outlier-feature-summaries.yaml | 13 +-
idn/beta/paths/outlier-summaries-latest.yaml | 13 +-
idn/beta/paths/outlier-summaries.yaml | 14 ++-
...ers-contributing-feature-access-items.yaml | 15 ++-
.../paths/outliers-contributing-features.yaml | 13 +-
idn/beta/paths/outliers-export.yaml | 16 ++-
idn/beta/paths/outliers-ignore.yaml | 28 +++--
idn/beta/paths/outliers-unignore.yaml | 28 +++--
idn/beta/paths/outliers.yaml | 12 +-
.../paths/outlier-feature-summaries.yaml | 51 ++++----
idn/v2024/paths/outlier-summaries-latest.yaml | 53 ++++----
idn/v2024/paths/outlier-summaries.yaml | 94 +++++++-------
...ers-contributing-feature-access-items.yaml | 117 +++++++++---------
.../paths/outliers-contributing-features.yaml | 93 +++++++-------
idn/v2024/paths/outliers-export.yaml | 54 ++++----
idn/v2024/paths/outliers-ignore.yaml | 34 ++---
idn/v2024/paths/outliers-unignore.yaml | 34 ++---
idn/v2024/paths/outliers.yaml | 109 ++++++++--------
19 files changed, 441 insertions(+), 384 deletions(-)
diff --git a/idn/beta/paths/json-web-key-set.yaml b/idn/beta/paths/json-web-key-set.yaml
index 1005f1d4..63a69f88 100644
--- a/idn/beta/paths/json-web-key-set.yaml
+++ b/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':
diff --git a/idn/beta/paths/outlier-feature-summaries.yaml b/idn/beta/paths/outlier-feature-summaries.yaml
index 22c9cfeb..9f879a0b 100644
--- a/idn/beta/paths/outlier-feature-summaries.yaml
+++ b/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
\ No newline at end of file
diff --git a/idn/beta/paths/outlier-summaries-latest.yaml b/idn/beta/paths/outlier-summaries-latest.yaml
index c73864f0..a6841711 100644
--- a/idn/beta/paths/outlier-summaries-latest.yaml
+++ b/idn/beta/paths/outlier-summaries-latest.yaml
@@ -4,14 +4,13 @@ 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:
@@ -19,7 +18,7 @@ get:
- 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
\ No newline at end of file
diff --git a/idn/beta/paths/outlier-summaries.yaml b/idn/beta/paths/outlier-summaries.yaml
index ecdcc985..cf5784c6 100644
--- a/idn/beta/paths/outlier-summaries.yaml
+++ b/idn/beta/paths/outlier-summaries.yaml
@@ -4,9 +4,7 @@ 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'
@@ -14,6 +12,7 @@ get:
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
diff --git a/idn/beta/paths/outliers-contributing-feature-access-items.yaml b/idn/beta/paths/outliers-contributing-feature-access-items.yaml
index 762534fb..61e3d87c 100644
--- a/idn/beta/paths/outliers-contributing-feature-access-items.yaml
+++ b/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 ]
\ No newline at end of file
+ - userAuth: [iai:outliers:read, iai:outliers:manage]
+ - applicationAuth: [iai:outliers:read, iai:outliers:manage]
+ x-sailpoint-userLevels:
+ - ORG_ADMIN
+ - REPORT_ADMIN
\ No newline at end of file
diff --git a/idn/beta/paths/outliers-contributing-features.yaml b/idn/beta/paths/outliers-contributing-features.yaml
index 5c010d47..bd78c8bf 100644
--- a/idn/beta/paths/outliers-contributing-features.yaml
+++ b/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
\ No newline at end of file
diff --git a/idn/beta/paths/outliers-export.yaml b/idn/beta/paths/outliers-export.yaml
index f8d4841b..91de414e 100644
--- a/idn/beta/paths/outliers-export.yaml
+++ b/idn/beta/paths/outliers-export.yaml
@@ -3,16 +3,16 @@ 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:
@@ -20,7 +20,7 @@ get:
- 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
diff --git a/idn/beta/paths/outliers-ignore.yaml b/idn/beta/paths/outliers-ignore.yaml
index 4b564677..9619b9e2 100644
--- a/idn/beta/paths/outliers-ignore.yaml
+++ b/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
diff --git a/idn/beta/paths/outliers-unignore.yaml b/idn/beta/paths/outliers-unignore.yaml
index 6b9e3a0c..d1b5d20e 100644
--- a/idn/beta/paths/outliers-unignore.yaml
+++ b/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
diff --git a/idn/beta/paths/outliers.yaml b/idn/beta/paths/outliers.yaml
index 722f2619..ed35c77b 100644
--- a/idn/beta/paths/outliers.yaml
+++ b/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
diff --git a/idn/v2024/paths/outlier-feature-summaries.yaml b/idn/v2024/paths/outlier-feature-summaries.yaml
index cec25247..d8ac9e4d 100644
--- a/idn/v2024/paths/outlier-feature-summaries.yaml
+++ b/idn/v2024/paths/outlier-feature-summaries.yaml
@@ -1,35 +1,31 @@
get:
operationId: getOutlierContributingFeatureSummary
tags:
- - IAI Outliers
+ - IAI Outliers
summary: Get identity outlier contibuting feature summary
- 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
+ description: |
+ This API returns a summary of a contributing feature for an identity outlier.
- 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
- schema:
- type: string
- required: true
- description: Contributing feature id
- example: 04654b66-7561-4090-94f9-abee0722a1af
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ - in: path
+ name: outlierFeatureId
+ schema:
+ type: string
+ required: true
+ description: Contributing feature id
+ example: 04654b66-7561-4090-94f9-abee0722a1af
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
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
@@ -52,5 +48,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
\ No newline at end of file
diff --git a/idn/v2024/paths/outlier-summaries-latest.yaml b/idn/v2024/paths/outlier-summaries-latest.yaml
index 42f69b5d..0ecb12f6 100644
--- a/idn/v2024/paths/outlier-summaries-latest.yaml
+++ b/idn/v2024/paths/outlier-summaries-latest.yaml
@@ -1,35 +1,32 @@
get:
operationId: getLatestIdentityOutlierSnapshots
tags:
- - IAI Outliers
+ - 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'''
+ 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.
parameters:
- - name: type
- in: query
- description: Type of the identity outliers snapshot to filter on
- required: false
- schema:
- type: string
- enum:
- - LOW_SIMILARITY
- - STRUCTURAL
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ - 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
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
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:
@@ -48,3 +45,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
\ No newline at end of file
diff --git a/idn/v2024/paths/outlier-summaries.yaml b/idn/v2024/paths/outlier-summaries.yaml
index ea80a4db..b817e2c6 100644
--- a/idn/v2024/paths/outlier-summaries.yaml
+++ b/idn/v2024/paths/outlier-summaries.yaml
@@ -1,57 +1,57 @@
get:
operationId: getIdentityOutlierSnapshots
tags:
- - IAI Outliers
+ - 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'''
+ description: >-
+ 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
- schema:
- type: string
- enum:
- - LOW_SIMILARITY
- - STRUCTURAL
- - in: query
- name: filters
- schema:
- type: string
- description: 'Filter results using the standard syntax described in [V3 API Standard
- Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
-
+ - $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:
+ - LOW_SIMILARITY
+ - STRUCTURAL
+ - in: query
+ name: filters
+ schema:
+ type: string
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following fields and operators:
+ Filtering is supported for the following fields and operators:
- **snapshotDate**: *ge, le*'
- example: snapshotDate ge "2022-02-07T20:13:29.356648026Z"
- - in: query
- name: sorters
- schema:
- type: string
- format: comma-separated
- description: 'Sort results using the standard syntax described in [V3 API Standard
- Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+ **snapshotDate**: *ge, le*
+ example: snapshotDate ge "2022-02-07T20:13:29.356648026Z"
+ required: false
+ - in: query
+ name: sorters
+ schema:
+ type: string
+ format: comma-separated
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **snapshotDate**'
- example: snapshotDate
- required: false
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ Sorting is supported for the following fields: **snapshotDate**
+ example: snapshotDate
+ required: false
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
responses:
'200':
description: Succeeded. Returns list of objects. Each object is a summary to
@@ -79,3 +79,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
\ No newline at end of file
diff --git a/idn/v2024/paths/outliers-contributing-feature-access-items.yaml b/idn/v2024/paths/outliers-contributing-feature-access-items.yaml
index d3ff6e0b..c9e0f74e 100644
--- a/idn/v2024/paths/outliers-contributing-feature-access-items.yaml
+++ b/idn/v2024/paths/outliers-contributing-feature-access-items.yaml
@@ -2,67 +2,63 @@ get:
operationId: listOutliersContributingFeatureAccessItems
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
+ 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.
- 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
- - $ref: ../../v3/parameters/count.yaml
- - in: path
- name: outlierId
- schema:
- type: string
- required: true
- description: The outlier id
- example: 2c918085842e69ae018432d22ccb212f
- - in: path
- name: contributingFeatureName
- schema:
- type: string
- enum:
- - radical_entitlement_count
- - entitlement_count
- - max_jaccard_similarity
- - mean_max_bundle_concurrency
- - single_entitlement_bundle_count
- - peerless_score
- required: true
- description: The name of contributing feature
- example: entitlement_count
- - in: query
- name: accessType
- required: false
- schema:
- type: string
- description: The type of access item for the identity outlier contributing feature.
- If not provided, it returns all
- example: ENTITLEMENT
- - in: query
- name: sorters
- required: false
- schema:
- type: string
- format: comma-separated
- example: displayName
- description: 'Sort results using the standard syntax described in [V3 API Standard
- Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ - $ref: ../../v3/parameters/limit.yaml
+ - $ref: ../../v3/parameters/offset.yaml
+ - $ref: ../../v3/parameters/count.yaml
+ - in: path
+ name: outlierId
+ schema:
+ type: string
+ required: true
+ description: The outlier id
+ example: 2c918085842e69ae018432d22ccb212f
+ - in: path
+ name: contributingFeatureName
+ schema:
+ type: string
+ enum:
+ - radical_entitlement_count
+ - entitlement_count
+ - max_jaccard_similarity
+ - mean_max_bundle_concurrency
+ - single_entitlement_bundle_count
+ - peerless_score
+ required: true
+ description: The name of contributing feature
+ example: entitlement_count
+ - in: query
+ name: accessType
+ required: false
+ schema:
+ type: string
+ description: The type of access item for the identity outlier contributing feature. If not provided, it returns all.
+ example: ENTITLEMENT
+ - in: query
+ name: sorters
+ required: false
+ schema:
+ type: string
+ format: comma-separated
+ example: displayName
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **displayName**'
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ Sorting is supported for the following fields: **displayName**
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
responses:
'200':
description: The list of access items.
@@ -85,5 +81,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
diff --git a/idn/v2024/paths/outliers-contributing-features.yaml b/idn/v2024/paths/outliers-contributing-features.yaml
index 598d4302..c8fb7a05 100644
--- a/idn/v2024/paths/outliers-contributing-features.yaml
+++ b/idn/v2024/paths/outliers-contributing-features.yaml
@@ -1,65 +1,60 @@
get:
operationId: getPeerGroupOutliersContributingFeatures
tags:
- - IAI Outliers
+ - IAI Outliers
summary: Get identity outlier's contibuting features
- 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
+ description: |
+ This API returns a list of contributing feature objects for a single outlier.
- 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
- - $ref: ../../v3/parameters/count.yaml
- - name: include-translation-messages
- in: query
- description: Whether or not to include translation messages object in returned
- response
- required: false
- schema:
- type: string
- example: include-translation-messages=
- - in: path
- example: 2c918085842e69ae018432d22ccb212f
- name: outlierId
- schema:
- type: string
- required: true
- description: The outlier id
- - in: query
- name: sorters
- required: false
- schema:
- type: string
- format: comma-separated
- example: importance
- description: 'Sort results using the standard syntax described in [V3 API Standard
- Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ - $ref: ../../v3/parameters/limit.yaml
+ - $ref: ../../v3/parameters/offset.yaml
+ - $ref: ../../v3/parameters/count.yaml
+ - name: include-translation-messages
+ in: query
+ description: Whether or not to include translation messages object in returned response
+ required: false
+ schema:
+ type: string
+ example: include-translation-messages=
+ - in: path
+ example: 2c918085842e69ae018432d22ccb212f
+ name: outlierId
+ schema:
+ type: string
+ required: true
+ description: The outlier id
+ - in: query
+ name: sorters
+ required: false
+ schema:
+ type: string
+ format: comma-separated
+ example: importance
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **importance**'
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ Sorting is supported for the following fields: **importance**
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
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.
schema:
type: integer
accept-language:
- description: The locale to use for translations for displayName and description
- text
+ description: The locale to use for translations for displayName and description text
schema:
type: string
content:
@@ -80,3 +75,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
diff --git a/idn/v2024/paths/outliers-export.yaml b/idn/v2024/paths/outliers-export.yaml
index 7b9c9c1c..62dbac99 100644
--- a/idn/v2024/paths/outliers-export.yaml
+++ b/idn/v2024/paths/outliers-export.yaml
@@ -1,36 +1,34 @@
get:
operationId: exportOutliersZip
tags:
- - IAI Outliers
+ - 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
- schema:
- type: string
- enum:
- - LOW_SIMILARITY
- - STRUCTURAL
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ - 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
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
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:
@@ -46,3 +44,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
diff --git a/idn/v2024/paths/outliers-ignore.yaml b/idn/v2024/paths/outliers-ignore.yaml
index 3071b642..38566e59 100644
--- a/idn/v2024/paths/outliers-ignore.yaml
+++ b/idn/v2024/paths/outliers-ignore.yaml
@@ -1,12 +1,10 @@
post:
operationId: ignoreIdentityOutliers
tags:
- - IAI Outliers
+ - 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'''
+ description: >-
+ This API receives a list of identity IDs in the request, changes the outliers to be ignored.
requestBody:
required: true
content:
@@ -16,9 +14,7 @@ post:
items:
type: string
description: List of identity IDs to ignore from outlier listing
- example:
- - abc123def456
- - ghi789jkl012
+ example: ['897ef96559df40e1baa6bae6b53e7340', '2c918085837fbfb4018384420dac60c3']
responses:
'204':
$ref: ../../v3/responses/204.yaml
@@ -33,11 +29,17 @@ post:
'500':
$ref: ../../v3/responses/500.yaml
parameters:
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
+ security:
+ - userAuth: [iai:outliers:manage]
+ - applicationAuth: [iai:outliers:manage]
+ x-sailpoint-userLevels:
+ - ORG_ADMIN
+ - REPORT_ADMIN
diff --git a/idn/v2024/paths/outliers-unignore.yaml b/idn/v2024/paths/outliers-unignore.yaml
index ca8b0392..4576066d 100644
--- a/idn/v2024/paths/outliers-unignore.yaml
+++ b/idn/v2024/paths/outliers-unignore.yaml
@@ -1,12 +1,10 @@
post:
operationId: unIgnoreIdentityOutliers
tags:
- - IAI Outliers
+ - 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'''
+ description: >-
+ This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
requestBody:
required: true
content:
@@ -16,9 +14,7 @@ post:
items:
type: string
description: List of identity IDs to un-ignore from outlier listing
- example:
- - abc123def456
- - ghi789jkl012
+ example: ['897ef96559df40e1baa6bae6b53e7340', '2c918085837fbfb4018384420dac60c3']
responses:
'204':
$ref: ../../v3/responses/204.yaml
@@ -33,11 +29,17 @@ post:
'500':
$ref: ../../v3/responses/500.yaml
parameters:
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
+ security:
+ - userAuth: [iai:outliers:manage]
+ - applicationAuth: [iai:outliers:manage]
+ x-sailpoint-userLevels:
+ - ORG_ADMIN
+ - REPORT_ADMIN
diff --git a/idn/v2024/paths/outliers.yaml b/idn/v2024/paths/outliers.yaml
index 1be4bcf8..9c3c6586 100644
--- a/idn/v2024/paths/outliers.yaml
+++ b/idn/v2024/paths/outliers.yaml
@@ -1,78 +1,73 @@
get:
operationId: getIdentityOutliers
tags:
- - IAI Outliers
+ - 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'''
+ description: >-
+ 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
- - $ref: ../../v3/parameters/count.yaml
- - name: type
- in: query
- description: Type of the identity outliers snapshot to filter on
- required: false
- schema:
- type: string
- enum:
- - LOW_SIMILARITY
- - STRUCTURAL
- example: LOW_SIMILARITY
- - in: query
- name: filters
- required: false
- schema:
- type: string
- description: 'Filter results using the standard syntax described in [V3 API Standard
- Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ - $ref: ../../v3/parameters/limit.yaml
+ - $ref: ../../v3/parameters/offset.yaml
+ - $ref: ../../v3/parameters/count.yaml
+ - name: type
+ in: query
+ description: Type of the identity outliers snapshot to filter on
+ required: false
+ schema:
+ type: string
+ enum:
+ - LOW_SIMILARITY
+ - STRUCTURAL
+ example: LOW_SIMILARITY
+ - in: query
+ name: filters
+ required: false
+ schema:
+ type: string
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following fields and operators:
+ Filtering is supported for the following fields and operators:
- **attributes**: *eq, sw, co, in*
+ **attributes**: *eq, sw, co, in*
- **firstDetectionDate**: *ge, le*
+ **firstDetectionDate**: *ge, le*
- **certStatus**: *eq*
+ **certStatus**: *eq*
- **ignored**: *eq*
+ **ignored**: *eq*
- **score**: *ge, le*'
- example: attributes.displayName sw "John" and certStatus eq "false"
- - in: query
- name: sorters
- required: false
- schema:
- type: string
- format: comma-separated
- description: 'Sort results using the standard syntax described in [V3 API Standard
- Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ **score**: *ge, le*
+ example: attributes.displayName sw "John" and certStatus eq "false"
+ - in: query
+ name: sorters
+ required: false
+ schema:
+ type: string
+ format: comma-separated
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **firstDetectionDate, attributes,
- score**'
- example: attributes.displayName,firstDetectionDate,-score
- - name: X-SailPoint-Experimental
- in: header
- description: Use this header to enable this experimental API.
- example: true
- schema:
- type: string
- default: true
- required: true
+ Sorting is supported for the following fields: **firstDetectionDate, attributes, score**
+ example: attributes.displayName,firstDetectionDate,-score
+ - name: X-SailPoint-Experimental
+ in: header
+ description: Use this header to enable this experimental API.
+ example: true
+ schema:
+ type: string
+ default: true
+ required: true
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.
@@ -94,3 +89,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