Skip to main content

IAI Get Identity Outliers

GET 
/outliers

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'

Request​

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    type string

    Possible values: [LOW_SIMILARITY, STRUCTURAL]

    Type of the identity outliers snapshot to filter on

    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    attributes: eq, sw, co, in

    firstDetectionDate: ge, le

    certStatus: eq

    ignored: eq

    score: ge, le

    Example: attributes.displayName sw "John" and certStatus eq "false"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: firstDetectionDate, attributes, score

    Example: attributes.displayName,firstDetectionDate,-score

Responses​

Succeeded. Returns list of objects. Each object contains information about outliers

Response Headers

  • X-Total-Count

    integer

    The total result count.

Schema

  • Array [

    • id string

    The identity's unique identifier for the outlier record

    identityId string

    The ID of the identity that is detected as an outlier

    type string

    Possible values: [LOW_SIMILARITY, STRUCTURAL]

    The type of outlier summary

    firstDetectionDate date-time

    The first date the outlier was detected

    latestDetectionDate date-time

    The most recent date the outlier was detected

    ignored boolean

    Flag whether or not the outlier has been ignored

    attributes object

    Object containing mapped identity attributes

    score float

    The outlier score determined by the detection engine ranging from 0..1

    unignoreType stringnullable

    Possible values: [MANUAL, AUTOMATIC, null]

    Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored

    unignoreDate date-timenullable

    shows date when last time has been unignored outlier

    ignoreDate date-timenullable

    shows date when last time has been ignored outlier

  • ]

Loading...