IAIOutliersApi
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| export-outliers-zip-v1 | GET /outliers/v1/export | Iai identity outliers export |
| get-identity-outlier-snapshots-v1 | GET /outlier-summaries/v1 | Iai identity outliers summary |
| get-identity-outliers-v1 | GET /outliers/v1 | Iai get identity outliers |
| get-latest-identity-outlier-snapshots-v1 | GET /outlier-summaries/v1/latest | Iai identity outliers latest summary |
| get-outlier-contributing-feature-summary-v1 | GET /outlier-feature-summaries/v1/{outlierFeatureId} | Get identity outlier contibuting feature summary |
| get-peer-group-outliers-contributing-features-v1 | GET /outliers/v1/{outlierId}/contributing-features | Get identity outlier's contibuting features |
| ignore-identity-outliers-v1 | POST /outliers/v1/ignore | Iai identity outliers ignore |
| list-outliers-contributing-feature-access-items-v1 | GET /outliers/v1/{outlierId}/feature-details/{contributingFeatureName}/access-items | Gets a list of access items associated with each identity outlier contributing feature |
| un-ignore-identity-outliers-v1 | POST /outliers/v1/unignore | Iai identity outliers unignore |
export-outliers-zip-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Iai identity outliers export 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).
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| type | `'LOW_SIMILARITY' | 'STRUCTURAL'` | Type of the identity outliers snapshot to filter on |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
File
HTTP request headers
- Content-Type: Not defined
- Accept: application/zip, application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.exportOutliersZipV1({ });
console.log(result);
get-identity-outlier-snapshots-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Iai identity outliers summary This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 0] |
| type | `'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: snapshotDate: ge, le | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: snapshotDate | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Outliersummary>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional)
const filters: string = snapshotDate ge "2022-02-07T20:13:29.356648026Z"; // 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* (optional)
const sorters: string = snapshotDate; // 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** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getIdentityOutlierSnapshotsV1({ });
console.log(result);
get-identity-outliers-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Iai get identity outliers 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
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 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. | [optional] [default to false] |
| type | `'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 | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: firstDetectionDate, attributes, score | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Outlier>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional)
const filters: string = attributes.displayName sw "John" and certStatus eq "false"; // 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional)
const sorters: string = attributes.displayName,firstDetectionDate,-score; // 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** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getIdentityOutliersV1({ });
console.log(result);
get-latest-identity-outlier-snapshots-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Iai identity outliers latest summary 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 | Description | Notes |
|---|---|---|---|
| type | `'LOW_SIMILARITY' | 'STRUCTURAL'` | Type of the identity outliers snapshot to filter on |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Latestoutliersummary>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getLatestIdentityOutlierSnapshotsV1({ });
console.log(result);
get-outlier-contributing-feature-summary-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get identity outlier contibuting feature summary 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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| outlierFeatureId | string | Contributing feature id | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Outlierfeaturesummary
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const outlierFeatureId: string = 04654b66-7561-4090-94f9-abee0722a1af; // Contributing feature id
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getOutlierContributingFeatureSummaryV1({ outlierFeatureId: outlierFeatureId });
console.log(result);
get-peer-group-outliers-contributing-features-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get identity outlier's contibuting features 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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| outlierId | string | The outlier id | [default to undefined] |
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 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. | [optional] [default to false] |
| includeTranslationMessages | string | Whether or not to include translation messages object in returned response | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: importance | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Outliercontributingfeature>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const outlierId: string = 2c918085842e69ae018432d22ccb212f; // The outlier id
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const includeTranslationMessages: string = include-translation-messages=; // Whether or not to include translation messages object in returned response (optional)
const sorters: string = importance; // 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** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getPeerGroupOutliersContributingFeaturesV1({ outlierId: outlierId });
console.log(result);
ignore-identity-outliers-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Iai identity outliers ignore This API receives a list of identity IDs in the request, changes the outliers to be ignored.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| requestBody | Array<string> | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
(empty response body)
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const requestBody: Array<string> = ; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.ignoreIdentityOutliersV1({ requestBody: requestBody });
console.log(result);
list-outliers-contributing-feature-access-items-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Gets a list of access items associated with each identity outlier contributing feature 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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| outlierId | string | The outlier id | [default to undefined] |
| contributingFeatureName | `'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' |
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 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. | [optional] [default to false] |
| accessType | string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Outlierscontributingfeatureaccessitems>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const outlierId: string = 2c918085842e69ae018432d22ccb212f; // The outlier id
const contributingFeatureName: string = entitlement_count; // The name of contributing feature
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const accessType: string = ENTITLEMENT; // The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional)
const sorters: string = displayName; // 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** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.listOutliersContributingFeatureAccessItemsV1({ outlierId: outlierId, contributingFeatureName: contributingFeatureName });
console.log(result);
un-ignore-identity-outliers-v1
experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Iai identity outliers unignore This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| requestBody | Array<string> | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
(empty response body)
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIOutliersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIOutliersApi(configuration);
const requestBody: Array<string> = ; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.unIgnoreIdentityOutliersV1({ requestBody: requestBody });
console.log(result);