/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - IAI Outliers * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetIdentityOutlierSnapshotsV1401Response */ export interface GetIdentityOutlierSnapshotsV1401Response { /** * A message describing the error * @type {any} * @memberof GetIdentityOutlierSnapshotsV1401Response */ 'error'?: any; } /** * * @export * @interface GetIdentityOutlierSnapshotsV1429Response */ export interface GetIdentityOutlierSnapshotsV1429Response { /** * A message describing the error * @type {any} * @memberof GetIdentityOutlierSnapshotsV1429Response */ 'message'?: any; } /** * * @export * @interface LatestOutlierSummary */ export interface LatestOutlierSummary { /** * The type of outlier summary * @type {string} * @memberof LatestOutlierSummary */ 'type'?: LatestOutlierSummaryTypeEnum; /** * The date the bulk outlier detection ran/snapshot was created * @type {string} * @memberof LatestOutlierSummary */ 'snapshotDate'?: string; /** * Total number of outliers for the customer making the request * @type {number} * @memberof LatestOutlierSummary */ 'totalOutliers'?: number; /** * Total number of identities for the customer making the request * @type {number} * @memberof LatestOutlierSummary */ 'totalIdentities'?: number; /** * Total number of ignored outliers * @type {number} * @memberof LatestOutlierSummary */ 'totalIgnored'?: number; } export const LatestOutlierSummaryTypeEnum = { LowSimilarity: 'LOW_SIMILARITY', Structural: 'STRUCTURAL' } as const; export type LatestOutlierSummaryTypeEnum = typeof LatestOutlierSummaryTypeEnum[keyof typeof LatestOutlierSummaryTypeEnum]; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface Outlier */ export interface Outlier { /** * The identity\'s unique identifier for the outlier record * @type {string} * @memberof Outlier */ 'id'?: string; /** * The ID of the identity that is detected as an outlier * @type {string} * @memberof Outlier */ 'identityId'?: string; /** * The type of outlier summary * @type {string} * @memberof Outlier */ 'type'?: OutlierTypeEnum; /** * The first date the outlier was detected * @type {string} * @memberof Outlier */ 'firstDetectionDate'?: string; /** * The most recent date the outlier was detected * @type {string} * @memberof Outlier */ 'latestDetectionDate'?: string; /** * Flag whether or not the outlier has been ignored * @type {boolean} * @memberof Outlier */ 'ignored'?: boolean; /** * Object containing mapped identity attributes * @type {object} * @memberof Outlier */ 'attributes'?: object; /** * The outlier score determined by the detection engine ranging from 0..1 * @type {number} * @memberof Outlier */ 'score'?: number; /** * Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored * @type {string} * @memberof Outlier */ 'unignoreType'?: OutlierUnignoreTypeEnum | null; /** * shows date when last time has been unignored outlier * @type {string} * @memberof Outlier */ 'unignoreDate'?: string | null; /** * shows date when last time has been ignored outlier * @type {string} * @memberof Outlier */ 'ignoreDate'?: string | null; } export const OutlierTypeEnum = { LowSimilarity: 'LOW_SIMILARITY', Structural: 'STRUCTURAL' } as const; export type OutlierTypeEnum = typeof OutlierTypeEnum[keyof typeof OutlierTypeEnum]; export const OutlierUnignoreTypeEnum = { Manual: 'MANUAL', Automatic: 'AUTOMATIC' } as const; export type OutlierUnignoreTypeEnum = typeof OutlierUnignoreTypeEnum[keyof typeof OutlierUnignoreTypeEnum]; /** * * @export * @interface OutlierContributingFeature */ export interface OutlierContributingFeature { /** * Contributing feature id * @type {string} * @memberof OutlierContributingFeature */ 'id'?: string; /** * The name of the feature * @type {string} * @memberof OutlierContributingFeature */ 'name'?: string; /** * * @type {OutlierValueType} * @memberof OutlierContributingFeature */ 'valueType'?: OutlierValueType; /** * The feature value * @type {number} * @memberof OutlierContributingFeature */ 'value'?: number; /** * The importance of the feature. This can also be a negative value * @type {number} * @memberof OutlierContributingFeature */ 'importance'?: number; /** * The (translated if header is passed) displayName for the feature * @type {string} * @memberof OutlierContributingFeature */ 'displayName'?: string; /** * The (translated if header is passed) description for the feature * @type {string} * @memberof OutlierContributingFeature */ 'description'?: string; /** * * @type {OutlierFeatureTranslation} * @memberof OutlierContributingFeature */ 'translationMessages'?: OutlierFeatureTranslation | null; } /** * * @export * @interface OutlierFeatureSummary */ export interface OutlierFeatureSummary { /** * Contributing feature name * @type {string} * @memberof OutlierFeatureSummary */ 'contributingFeatureName'?: string; /** * Identity display name * @type {string} * @memberof OutlierFeatureSummary */ 'identityOutlierDisplayName'?: string; /** * * @type {Array} * @memberof OutlierFeatureSummary */ 'outlierFeatureDisplayValues'?: Array; /** * Definition of the feature * @type {string} * @memberof OutlierFeatureSummary */ 'featureDefinition'?: string; /** * Detailed explanation of the feature * @type {string} * @memberof OutlierFeatureSummary */ 'featureExplanation'?: string; /** * outlier\'s peer identity display name * @type {string} * @memberof OutlierFeatureSummary */ 'peerDisplayName'?: string | null; /** * outlier\'s peer identity id * @type {string} * @memberof OutlierFeatureSummary */ 'peerIdentityId'?: string | null; /** * Access Item reference * @type {object} * @memberof OutlierFeatureSummary */ 'accessItemReference'?: object; } /** * * @export * @interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInner */ export interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInner { /** * display name * @type {string} * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInner */ 'displayName'?: string; /** * value * @type {string} * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInner */ 'value'?: string; /** * * @type {OutlierValueType} * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInner */ 'valueType'?: OutlierValueType; } /** * * @export * @interface OutlierFeatureTranslation */ export interface OutlierFeatureTranslation { /** * * @type {TranslationMessage} * @memberof OutlierFeatureTranslation */ 'displayName'?: TranslationMessage; /** * * @type {TranslationMessage} * @memberof OutlierFeatureTranslation */ 'description'?: TranslationMessage; } /** * * @export * @interface OutlierSummary */ export interface OutlierSummary { /** * The type of outlier summary * @type {string} * @memberof OutlierSummary */ 'type'?: OutlierSummaryTypeEnum; /** * The date the bulk outlier detection ran/snapshot was created * @type {string} * @memberof OutlierSummary */ 'snapshotDate'?: string; /** * Total number of outliers for the customer making the request * @type {number} * @memberof OutlierSummary */ 'totalOutliers'?: number; /** * Total number of identities for the customer making the request * @type {number} * @memberof OutlierSummary */ 'totalIdentities'?: number; /** * * @type {number} * @memberof OutlierSummary */ 'totalIgnored'?: number; } export const OutlierSummaryTypeEnum = { LowSimilarity: 'LOW_SIMILARITY', Structural: 'STRUCTURAL' } as const; export type OutlierSummaryTypeEnum = typeof OutlierSummaryTypeEnum[keyof typeof OutlierSummaryTypeEnum]; /** * The data type of the value field * @export * @interface OutlierValueType */ export interface OutlierValueType { /** * The data type of the value field * @type {string} * @memberof OutlierValueType */ 'name'?: OutlierValueTypeNameEnum; /** * The position of the value type * @type {number} * @memberof OutlierValueType */ 'ordinal'?: number; } export const OutlierValueTypeNameEnum = { Integer: 'INTEGER', Float: 'FLOAT' } as const; export type OutlierValueTypeNameEnum = typeof OutlierValueTypeNameEnum[keyof typeof OutlierValueTypeNameEnum]; /** * * @export * @interface OutliersContributingFeatureAccessItems */ export interface OutliersContributingFeatureAccessItems { /** * The ID of the access item * @type {string} * @memberof OutliersContributingFeatureAccessItems */ 'id'?: string; /** * the display name of the access item * @type {string} * @memberof OutliersContributingFeatureAccessItems */ 'displayName'?: string; /** * Description of the access item. * @type {string} * @memberof OutliersContributingFeatureAccessItems */ 'description'?: string | null; /** * The type of the access item. * @type {string} * @memberof OutliersContributingFeatureAccessItems */ 'accessType'?: OutliersContributingFeatureAccessItemsAccessTypeEnum; /** * the associated source name if it exists * @type {string} * @memberof OutliersContributingFeatureAccessItems */ 'sourceName'?: string; /** * rarest access * @type {boolean} * @memberof OutliersContributingFeatureAccessItems */ 'extremelyRare'?: boolean; } export const OutliersContributingFeatureAccessItemsAccessTypeEnum = { Entitlement: 'ENTITLEMENT', AccessProfile: 'ACCESS_PROFILE', Role: 'ROLE' } as const; export type OutliersContributingFeatureAccessItemsAccessTypeEnum = typeof OutliersContributingFeatureAccessItemsAccessTypeEnum[keyof typeof OutliersContributingFeatureAccessItemsAccessTypeEnum]; /** * * @export * @interface TranslationMessage */ export interface TranslationMessage { /** * The key of the translation message * @type {string} * @memberof TranslationMessage */ 'key'?: string; /** * The values corresponding to the translation messages * @type {Array} * @memberof TranslationMessage */ 'values'?: Array; } /** * IAIOutliersApi - axios parameter creator * @export */ export const IAIOutliersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * 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). * @summary Iai identity outliers export * @param {ExportOutliersZipV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportOutliersZipV1: async (type?: ExportOutliersZipV1TypeEnum, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outliers/v1/export`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (type !== undefined) { localVarQueryParameter['type'] = type; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. * @summary Iai identity outliers summary * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {GetIdentityOutlierSnapshotsV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityOutlierSnapshotsV1: async (limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsV1TypeEnum, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outlier-summaries/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (type !== undefined) { localVarQueryParameter['type'] = type; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * 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. * @summary Iai get identity outliers * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {boolean} [count] 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. * @param {GetIdentityOutliersV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityOutliersV1: async (limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersV1TypeEnum, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outliers/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (type !== undefined) { localVarQueryParameter['type'] = type; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * 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. * @summary Iai identity outliers latest summary * @param {GetLatestIdentityOutlierSnapshotsV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLatestIdentityOutlierSnapshotsV1: async (type?: GetLatestIdentityOutlierSnapshotsV1TypeEnum, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outlier-summaries/v1/latest`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (type !== undefined) { localVarQueryParameter['type'] = type; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * 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. * @summary Get identity outlier contibuting feature summary * @param {string} outlierFeatureId Contributing feature id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOutlierContributingFeatureSummaryV1: async (outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'outlierFeatureId' is not null or undefined assertParamExists('getOutlierContributingFeatureSummaryV1', 'outlierFeatureId', outlierFeatureId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outlier-feature-summaries/v1/{outlierFeatureId}` .replace(`{${"outlierFeatureId"}}`, encodeURIComponent(String(outlierFeatureId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * 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. * @summary Get identity outlier\'s contibuting features * @param {string} outlierId The outlier id * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {boolean} [count] 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. * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPeerGroupOutliersContributingFeaturesV1: async (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'outlierId' is not null or undefined assertParamExists('getPeerGroupOutliersContributingFeaturesV1', 'outlierId', outlierId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outliers/v1/{outlierId}/contributing-features` .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (includeTranslationMessages !== undefined) { localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API receives a list of identity IDs in the request, changes the outliers to be ignored. * @summary Iai identity outliers ignore * @param {Array} requestBody * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ ignoreIdentityOutliersV1: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'requestBody' is not null or undefined assertParamExists('ignoreIdentityOutliersV1', 'requestBody', requestBody) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outliers/v1/ignore`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * 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. * @summary Gets a list of access items associated with each identity outlier contributing feature * @param {string} outlierId The outlier id * @param {ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum} contributingFeatureName The name of contributing feature * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {boolean} [count] 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. * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listOutliersContributingFeatureAccessItemsV1: async (outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'outlierId' is not null or undefined assertParamExists('listOutliersContributingFeatureAccessItemsV1', 'outlierId', outlierId) // verify required parameter 'contributingFeatureName' is not null or undefined assertParamExists('listOutliersContributingFeatureAccessItemsV1', 'contributingFeatureName', contributingFeatureName) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outliers/v1/{outlierId}/feature-details/{contributingFeatureName}/access-items` .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))) .replace(`{${"contributingFeatureName"}}`, encodeURIComponent(String(contributingFeatureName))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (accessType !== undefined) { localVarQueryParameter['accessType'] = accessType; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. * @summary Iai identity outliers unignore * @param {Array} requestBody * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ unIgnoreIdentityOutliersV1: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'requestBody' is not null or undefined assertParamExists('unIgnoreIdentityOutliersV1', 'requestBody', requestBody) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/outliers/v1/unignore`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * IAIOutliersApi - functional programming interface * @export */ export const IAIOutliersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = IAIOutliersApiAxiosParamCreator(configuration) return { /** * 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). * @summary Iai identity outliers export * @param {ExportOutliersZipV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async exportOutliersZipV1(type?: ExportOutliersZipV1TypeEnum, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.exportOutliersZipV1(type, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.exportOutliersZipV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. * @summary Iai identity outliers summary * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {GetIdentityOutlierSnapshotsV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityOutlierSnapshotsV1(limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsV1TypeEnum, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutlierSnapshotsV1(limit, offset, type, filters, sorters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.getIdentityOutlierSnapshotsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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. * @summary Iai get identity outliers * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {boolean} [count] 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. * @param {GetIdentityOutliersV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityOutliersV1(limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersV1TypeEnum, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutliersV1(limit, offset, count, type, filters, sorters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.getIdentityOutliersV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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. * @summary Iai identity outliers latest summary * @param {GetLatestIdentityOutlierSnapshotsV1TypeEnum} [type] Type of the identity outliers snapshot to filter on * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getLatestIdentityOutlierSnapshotsV1(type?: GetLatestIdentityOutlierSnapshotsV1TypeEnum, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestIdentityOutlierSnapshotsV1(type, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.getLatestIdentityOutlierSnapshotsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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. * @summary Get identity outlier contibuting feature summary * @param {string} outlierFeatureId Contributing feature id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getOutlierContributingFeatureSummaryV1(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getOutlierContributingFeatureSummaryV1(outlierFeatureId, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.getOutlierContributingFeatureSummaryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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. * @summary Get identity outlier\'s contibuting features * @param {string} outlierId The outlier id * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {boolean} [count] 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. * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getPeerGroupOutliersContributingFeaturesV1(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliersContributingFeaturesV1(outlierId, limit, offset, count, includeTranslationMessages, sorters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.getPeerGroupOutliersContributingFeaturesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API receives a list of identity IDs in the request, changes the outliers to be ignored. * @summary Iai identity outliers ignore * @param {Array} requestBody * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async ignoreIdentityOutliersV1(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.ignoreIdentityOutliersV1(requestBody, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.ignoreIdentityOutliersV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * 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. * @summary Gets a list of access items associated with each identity outlier contributing feature * @param {string} outlierId The outlier id * @param {ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum} contributingFeatureName The name of contributing feature * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {boolean} [count] 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. * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. * @param {string} [sorters] 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** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listOutliersContributingFeatureAccessItemsV1(outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listOutliersContributingFeatureAccessItemsV1(outlierId, contributingFeatureName, limit, offset, count, accessType, sorters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.listOutliersContributingFeatureAccessItemsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. * @summary Iai identity outliers unignore * @param {Array} requestBody * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async unIgnoreIdentityOutliersV1(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.unIgnoreIdentityOutliersV1(requestBody, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IAIOutliersApi.unIgnoreIdentityOutliersV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * IAIOutliersApi - factory interface * @export */ export const IAIOutliersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = IAIOutliersApiFp(configuration) return { /** * 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). * @summary Iai identity outliers export * @param {IAIOutliersApiExportOutliersZipV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportOutliersZipV1(requestParameters: IAIOutliersApiExportOutliersZipV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.exportOutliersZipV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. * @summary Iai identity outliers summary * @param {IAIOutliersApiGetIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersApiGetIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getIdentityOutlierSnapshotsV1(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * 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. * @summary Iai get identity outliers * @param {IAIOutliersApiGetIdentityOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityOutliersV1(requestParameters: IAIOutliersApiGetIdentityOutliersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getIdentityOutliersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * 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. * @summary Iai identity outliers latest summary * @param {IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLatestIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getLatestIdentityOutlierSnapshotsV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * 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. * @summary Get identity outlier contibuting feature summary * @param {IAIOutliersApiGetOutlierContributingFeatureSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOutlierContributingFeatureSummaryV1(requestParameters: IAIOutliersApiGetOutlierContributingFeatureSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getOutlierContributingFeatureSummaryV1(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * 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. * @summary Get identity outlier\'s contibuting features * @param {IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPeerGroupOutliersContributingFeaturesV1(requestParameters: IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getPeerGroupOutliersContributingFeaturesV1(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API receives a list of identity IDs in the request, changes the outliers to be ignored. * @summary Iai identity outliers ignore * @param {IAIOutliersApiIgnoreIdentityOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ ignoreIdentityOutliersV1(requestParameters: IAIOutliersApiIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.ignoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * 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. * @summary Gets a list of access items associated with each identity outlier contributing feature * @param {IAIOutliersApiListOutliersContributingFeatureAccessItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listOutliersContributingFeatureAccessItemsV1(requestParameters: IAIOutliersApiListOutliersContributingFeatureAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listOutliersContributingFeatureAccessItemsV1(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. * @summary Iai identity outliers unignore * @param {IAIOutliersApiUnIgnoreIdentityOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ unIgnoreIdentityOutliersV1(requestParameters: IAIOutliersApiUnIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.unIgnoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for exportOutliersZipV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiExportOutliersZipV1Request */ export interface IAIOutliersApiExportOutliersZipV1Request { /** * Type of the identity outliers snapshot to filter on * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} * @memberof IAIOutliersApiExportOutliersZipV1 */ readonly type?: ExportOutliersZipV1TypeEnum /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiExportOutliersZipV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getIdentityOutlierSnapshotsV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiGetIdentityOutlierSnapshotsV1Request */ export interface IAIOutliersApiGetIdentityOutlierSnapshotsV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IAIOutliersApiGetIdentityOutlierSnapshotsV1 */ readonly limit?: number /** * 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. * @type {number} * @memberof IAIOutliersApiGetIdentityOutlierSnapshotsV1 */ readonly offset?: number /** * Type of the identity outliers snapshot to filter on * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} * @memberof IAIOutliersApiGetIdentityOutlierSnapshotsV1 */ readonly type?: GetIdentityOutlierSnapshotsV1TypeEnum /** * 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* * @type {string} * @memberof IAIOutliersApiGetIdentityOutlierSnapshotsV1 */ readonly filters?: string /** * 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** * @type {string} * @memberof IAIOutliersApiGetIdentityOutlierSnapshotsV1 */ readonly sorters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiGetIdentityOutlierSnapshotsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getIdentityOutliersV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiGetIdentityOutliersV1Request */ export interface IAIOutliersApiGetIdentityOutliersV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IAIOutliersApiGetIdentityOutliersV1 */ readonly limit?: number /** * 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. * @type {number} * @memberof IAIOutliersApiGetIdentityOutliersV1 */ readonly offset?: number /** * 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. * @type {boolean} * @memberof IAIOutliersApiGetIdentityOutliersV1 */ readonly count?: boolean /** * Type of the identity outliers snapshot to filter on * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} * @memberof IAIOutliersApiGetIdentityOutliersV1 */ readonly type?: GetIdentityOutliersV1TypeEnum /** * 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* * @type {string} * @memberof IAIOutliersApiGetIdentityOutliersV1 */ readonly filters?: string /** * 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** * @type {string} * @memberof IAIOutliersApiGetIdentityOutliersV1 */ readonly sorters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiGetIdentityOutliersV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getLatestIdentityOutlierSnapshotsV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1Request */ export interface IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1Request { /** * Type of the identity outliers snapshot to filter on * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} * @memberof IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1 */ readonly type?: GetLatestIdentityOutlierSnapshotsV1TypeEnum /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getOutlierContributingFeatureSummaryV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiGetOutlierContributingFeatureSummaryV1Request */ export interface IAIOutliersApiGetOutlierContributingFeatureSummaryV1Request { /** * Contributing feature id * @type {string} * @memberof IAIOutliersApiGetOutlierContributingFeatureSummaryV1 */ readonly outlierFeatureId: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiGetOutlierContributingFeatureSummaryV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getPeerGroupOutliersContributingFeaturesV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1Request */ export interface IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1Request { /** * The outlier id * @type {string} * @memberof IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1 */ readonly outlierId: string /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1 */ readonly limit?: number /** * 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. * @type {number} * @memberof IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1 */ readonly offset?: number /** * 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. * @type {boolean} * @memberof IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1 */ readonly count?: boolean /** * Whether or not to include translation messages object in returned response * @type {string} * @memberof IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1 */ readonly includeTranslationMessages?: string /** * 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** * @type {string} * @memberof IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1 */ readonly sorters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for ignoreIdentityOutliersV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiIgnoreIdentityOutliersV1Request */ export interface IAIOutliersApiIgnoreIdentityOutliersV1Request { /** * * @type {Array} * @memberof IAIOutliersApiIgnoreIdentityOutliersV1 */ readonly requestBody: Array /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiIgnoreIdentityOutliersV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for listOutliersContributingFeatureAccessItemsV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiListOutliersContributingFeatureAccessItemsV1Request */ export interface IAIOutliersApiListOutliersContributingFeatureAccessItemsV1Request { /** * The outlier id * @type {string} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly outlierId: string /** * The name of contributing feature * @type {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly contributingFeatureName: ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly limit?: number /** * 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. * @type {number} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly offset?: number /** * 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. * @type {boolean} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly count?: boolean /** * The type of access item for the identity outlier contributing feature. If not provided, it returns all. * @type {string} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly accessType?: string /** * 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** * @type {string} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly sorters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiListOutliersContributingFeatureAccessItemsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for unIgnoreIdentityOutliersV1 operation in IAIOutliersApi. * @export * @interface IAIOutliersApiUnIgnoreIdentityOutliersV1Request */ export interface IAIOutliersApiUnIgnoreIdentityOutliersV1Request { /** * * @type {Array} * @memberof IAIOutliersApiUnIgnoreIdentityOutliersV1 */ readonly requestBody: Array /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIOutliersApiUnIgnoreIdentityOutliersV1 */ readonly xSailPointExperimental?: string } /** * IAIOutliersApi - object-oriented interface * @export * @class IAIOutliersApi * @extends {BaseAPI} */ export class IAIOutliersApi extends BaseAPI { /** * 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). * @summary Iai identity outliers export * @param {IAIOutliersApiExportOutliersZipV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public exportOutliersZipV1(requestParameters: IAIOutliersApiExportOutliersZipV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).exportOutliersZipV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. * @summary Iai identity outliers summary * @param {IAIOutliersApiGetIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public getIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersApiGetIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).getIdentityOutlierSnapshotsV1(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * 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. * @summary Iai get identity outliers * @param {IAIOutliersApiGetIdentityOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public getIdentityOutliersV1(requestParameters: IAIOutliersApiGetIdentityOutliersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).getIdentityOutliersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * 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. * @summary Iai identity outliers latest summary * @param {IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public getLatestIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersApiGetLatestIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).getLatestIdentityOutlierSnapshotsV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * 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. * @summary Get identity outlier contibuting feature summary * @param {IAIOutliersApiGetOutlierContributingFeatureSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public getOutlierContributingFeatureSummaryV1(requestParameters: IAIOutliersApiGetOutlierContributingFeatureSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).getOutlierContributingFeatureSummaryV1(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * 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. * @summary Get identity outlier\'s contibuting features * @param {IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public getPeerGroupOutliersContributingFeaturesV1(requestParameters: IAIOutliersApiGetPeerGroupOutliersContributingFeaturesV1Request, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).getPeerGroupOutliersContributingFeaturesV1(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API receives a list of identity IDs in the request, changes the outliers to be ignored. * @summary Iai identity outliers ignore * @param {IAIOutliersApiIgnoreIdentityOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public ignoreIdentityOutliersV1(requestParameters: IAIOutliersApiIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).ignoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * 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. * @summary Gets a list of access items associated with each identity outlier contributing feature * @param {IAIOutliersApiListOutliersContributingFeatureAccessItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public listOutliersContributingFeatureAccessItemsV1(requestParameters: IAIOutliersApiListOutliersContributingFeatureAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).listOutliersContributingFeatureAccessItemsV1(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. * @summary Iai identity outliers unignore * @param {IAIOutliersApiUnIgnoreIdentityOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIOutliersApi */ public unIgnoreIdentityOutliersV1(requestParameters: IAIOutliersApiUnIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig) { return IAIOutliersApiFp(this.configuration).unIgnoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } } /** * @export */ export const ExportOutliersZipV1TypeEnum = { LowSimilarity: 'LOW_SIMILARITY', Structural: 'STRUCTURAL' } as const; export type ExportOutliersZipV1TypeEnum = typeof ExportOutliersZipV1TypeEnum[keyof typeof ExportOutliersZipV1TypeEnum]; /** * @export */ export const GetIdentityOutlierSnapshotsV1TypeEnum = { LowSimilarity: 'LOW_SIMILARITY', Structural: 'STRUCTURAL' } as const; export type GetIdentityOutlierSnapshotsV1TypeEnum = typeof GetIdentityOutlierSnapshotsV1TypeEnum[keyof typeof GetIdentityOutlierSnapshotsV1TypeEnum]; /** * @export */ export const GetIdentityOutliersV1TypeEnum = { LowSimilarity: 'LOW_SIMILARITY', Structural: 'STRUCTURAL' } as const; export type GetIdentityOutliersV1TypeEnum = typeof GetIdentityOutliersV1TypeEnum[keyof typeof GetIdentityOutliersV1TypeEnum]; /** * @export */ export const GetLatestIdentityOutlierSnapshotsV1TypeEnum = { LowSimilarity: 'LOW_SIMILARITY', Structural: 'STRUCTURAL' } as const; export type GetLatestIdentityOutlierSnapshotsV1TypeEnum = typeof GetLatestIdentityOutlierSnapshotsV1TypeEnum[keyof typeof GetLatestIdentityOutlierSnapshotsV1TypeEnum]; /** * @export */ export const ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum = { RadicalEntitlementCount: 'radical_entitlement_count', EntitlementCount: 'entitlement_count', MaxJaccardSimilarity: 'max_jaccard_similarity', MeanMaxBundleConcurrency: 'mean_max_bundle_concurrency', SingleEntitlementBundleCount: 'single_entitlement_bundle_count', PeerlessScore: 'peerless_score' } as const; export type ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum = typeof ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum[keyof typeof ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameEnum];