mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
1013fe10a3
* Fixed sorter/filter descriptions for several endpoints. Moved beta collection tags into alphabetic order. * Fixed the remaining sorter/filter linter errors * Removed default value from sorter params as they are not valid.' by github action: 6708027043
73 lines
2.3 KiB
YAML
73 lines
2.3 KiB
YAML
get:
|
|
operationId: getIdentityOutlierSnapshots
|
|
tags:
|
|
- 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'
|
|
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)
|
|
|
|
|
|
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)
|
|
|
|
|
|
Sorting is supported for the following fields: **snapshotDate**
|
|
example: snapshotDate
|
|
required: false
|
|
responses:
|
|
'200':
|
|
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.
|
|
schema:
|
|
type: integer
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/OutlierSummary.yaml'
|
|
'202':
|
|
$ref: '../../v3/responses/202.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|