Skip to main content

IAI Identity Outliers Summary

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'

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

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

  • 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 field and operators: snapshotDate: ge, le

  • sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following field: snapshotDate

    Example: snapshotDate
Responses

Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers

Response Headers
  • X-Total-Count integer

    The total result count.


Schema array
  • type string

    Possible values: [LOW_SIMILARITY, STRUCTURAL]

    The type of outlier summary

  • snapshotDate date-time

    The date the bulk outlier detection ran/snapshot was created

  • totalOutliers integer

    Total number of outliers for the customer making the request

  • totalIdentities integer

    Total number of identities for the customer making the request

Loading...