mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +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
71 lines
2.4 KiB
YAML
71 lines
2.4 KiB
YAML
get:
|
|
operationId: getPeerGroupOutliersContributingFeatures
|
|
tags:
|
|
- 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
|
|
|
|
Requires authorization scope of 'iai:outliers-management:read'
|
|
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)
|
|
|
|
|
|
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
|
|
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
|
|
schema:
|
|
type: string
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/OutlierContributingFeature.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|