sailpoint-api-client 1.4.10 → 1.4.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/beta/README.md +2 -2
- package/beta/api.ts +90 -54
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +40 -40
- package/dist/beta/api.js +161 -71
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +175 -124
- package/dist/v2024/api.js +255 -158
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v3/api.d.ts +76 -64
- package/dist/v3/api.js +59 -59
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +229 -139
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +76 -64
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/beta/api.d.ts
CHANGED
|
@@ -42992,7 +42992,7 @@ export declare class IAIMessageCatalogsBetaApi extends BaseAPI {
|
|
|
42992
42992
|
*/
|
|
42993
42993
|
export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
42994
42994
|
/**
|
|
42995
|
-
* 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
|
|
42995
|
+
* 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).
|
|
42996
42996
|
* @summary IAI Identity Outliers Export
|
|
42997
42997
|
* @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
|
|
42998
42998
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43000,7 +43000,7 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43000
43000
|
*/
|
|
43001
43001
|
exportOutliersZip: (type?: 'LOW_SIMILARITY' | 'STRUCTURAL', axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43002
43002
|
/**
|
|
43003
|
-
* This API
|
|
43003
|
+
* This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
|
|
43004
43004
|
* @summary IAI Identity Outliers Summary
|
|
43005
43005
|
* @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.
|
|
43006
43006
|
* @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.
|
|
@@ -43012,7 +43012,7 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43012
43012
|
*/
|
|
43013
43013
|
getIdentityOutlierSnapshots: (limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43014
43014
|
/**
|
|
43015
|
-
* This API
|
|
43015
|
+
* 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.
|
|
43016
43016
|
* @summary IAI Get Identity Outliers
|
|
43017
43017
|
* @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.
|
|
43018
43018
|
* @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.
|
|
@@ -43025,7 +43025,7 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43025
43025
|
*/
|
|
43026
43026
|
getIdentityOutliers: (limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43027
43027
|
/**
|
|
43028
|
-
* This API returns a most recent snapshot of each outlier type, each containing
|
|
43028
|
+
* 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.
|
|
43029
43029
|
* @summary IAI Identity Outliers Latest Summary
|
|
43030
43030
|
* @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
|
|
43031
43031
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43033,7 +43033,7 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43033
43033
|
*/
|
|
43034
43034
|
getLatestIdentityOutlierSnapshots: (type?: 'LOW_SIMILARITY' | 'STRUCTURAL', axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43035
43035
|
/**
|
|
43036
|
-
* This API returns a summary of a contributing feature for an identity outlier.
|
|
43036
|
+
* 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.
|
|
43037
43037
|
* @summary Get identity outlier contibuting feature summary
|
|
43038
43038
|
* @param {string} outlierFeatureId Contributing feature id
|
|
43039
43039
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43041,7 +43041,7 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43041
43041
|
*/
|
|
43042
43042
|
getOutlierContributingFeatureSummary: (outlierFeatureId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43043
43043
|
/**
|
|
43044
|
-
* This API returns a list of contributing feature objects for a single outlier.
|
|
43044
|
+
* 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.
|
|
43045
43045
|
* @summary Get identity outlier\'s contibuting features
|
|
43046
43046
|
* @param {string} outlierId The outlier id
|
|
43047
43047
|
* @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.
|
|
@@ -43054,7 +43054,7 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43054
43054
|
*/
|
|
43055
43055
|
getPeerGroupOutliersContributingFeatures: (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43056
43056
|
/**
|
|
43057
|
-
* This API receives a list of
|
|
43057
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be ignored.
|
|
43058
43058
|
* @summary IAI Identity Outliers Ignore
|
|
43059
43059
|
* @param {Array<string>} requestBody
|
|
43060
43060
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43062,21 +43062,21 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43062
43062
|
*/
|
|
43063
43063
|
ignoreIdentityOutliers: (requestBody: Array<string>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43064
43064
|
/**
|
|
43065
|
-
* 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
|
|
43065
|
+
* 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.
|
|
43066
43066
|
* @summary Gets a list of access items associated with each identity outlier contributing feature
|
|
43067
43067
|
* @param {string} outlierId The outlier id
|
|
43068
43068
|
* @param {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} contributingFeatureName The name of contributing feature
|
|
43069
43069
|
* @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.
|
|
43070
43070
|
* @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.
|
|
43071
43071
|
* @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.
|
|
43072
|
-
* @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
|
|
43072
|
+
* @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
|
|
43073
43073
|
* @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**
|
|
43074
43074
|
* @param {*} [axiosOptions] Override http request option.
|
|
43075
43075
|
* @throws {RequiredError}
|
|
43076
43076
|
*/
|
|
43077
43077
|
listOutliersContributingFeatureAccessItems: (outlierId: string, contributingFeatureName: 'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score', limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43078
43078
|
/**
|
|
43079
|
-
* This API receives a list of
|
|
43079
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
|
|
43080
43080
|
* @summary IAI Identity Outliers Unignore
|
|
43081
43081
|
* @param {Array<string>} requestBody
|
|
43082
43082
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43090,7 +43090,7 @@ export declare const IAIOutliersBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
43090
43090
|
*/
|
|
43091
43091
|
export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
43092
43092
|
/**
|
|
43093
|
-
* 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
|
|
43093
|
+
* 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).
|
|
43094
43094
|
* @summary IAI Identity Outliers Export
|
|
43095
43095
|
* @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
|
|
43096
43096
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43098,7 +43098,7 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43098
43098
|
*/
|
|
43099
43099
|
exportOutliersZip(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
43100
43100
|
/**
|
|
43101
|
-
* This API
|
|
43101
|
+
* This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
|
|
43102
43102
|
* @summary IAI Identity Outliers Summary
|
|
43103
43103
|
* @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.
|
|
43104
43104
|
* @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.
|
|
@@ -43110,7 +43110,7 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43110
43110
|
*/
|
|
43111
43111
|
getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutlierSummaryBeta>>>;
|
|
43112
43112
|
/**
|
|
43113
|
-
* This API
|
|
43113
|
+
* 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.
|
|
43114
43114
|
* @summary IAI Get Identity Outliers
|
|
43115
43115
|
* @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.
|
|
43116
43116
|
* @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.
|
|
@@ -43123,7 +43123,7 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43123
43123
|
*/
|
|
43124
43124
|
getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutlierBeta>>>;
|
|
43125
43125
|
/**
|
|
43126
|
-
* This API returns a most recent snapshot of each outlier type, each containing
|
|
43126
|
+
* 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.
|
|
43127
43127
|
* @summary IAI Identity Outliers Latest Summary
|
|
43128
43128
|
* @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
|
|
43129
43129
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43131,7 +43131,7 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43131
43131
|
*/
|
|
43132
43132
|
getLatestIdentityOutlierSnapshots(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LatestOutlierSummaryBeta>>>;
|
|
43133
43133
|
/**
|
|
43134
|
-
* This API returns a summary of a contributing feature for an identity outlier.
|
|
43134
|
+
* 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.
|
|
43135
43135
|
* @summary Get identity outlier contibuting feature summary
|
|
43136
43136
|
* @param {string} outlierFeatureId Contributing feature id
|
|
43137
43137
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43139,7 +43139,7 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43139
43139
|
*/
|
|
43140
43140
|
getOutlierContributingFeatureSummary(outlierFeatureId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutlierFeatureSummaryBeta>>;
|
|
43141
43141
|
/**
|
|
43142
|
-
* This API returns a list of contributing feature objects for a single outlier.
|
|
43142
|
+
* 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.
|
|
43143
43143
|
* @summary Get identity outlier\'s contibuting features
|
|
43144
43144
|
* @param {string} outlierId The outlier id
|
|
43145
43145
|
* @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.
|
|
@@ -43152,7 +43152,7 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43152
43152
|
*/
|
|
43153
43153
|
getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutlierContributingFeatureBeta>>>;
|
|
43154
43154
|
/**
|
|
43155
|
-
* This API receives a list of
|
|
43155
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be ignored.
|
|
43156
43156
|
* @summary IAI Identity Outliers Ignore
|
|
43157
43157
|
* @param {Array<string>} requestBody
|
|
43158
43158
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43160,21 +43160,21 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43160
43160
|
*/
|
|
43161
43161
|
ignoreIdentityOutliers(requestBody: Array<string>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
43162
43162
|
/**
|
|
43163
|
-
* 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
|
|
43163
|
+
* 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.
|
|
43164
43164
|
* @summary Gets a list of access items associated with each identity outlier contributing feature
|
|
43165
43165
|
* @param {string} outlierId The outlier id
|
|
43166
43166
|
* @param {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} contributingFeatureName The name of contributing feature
|
|
43167
43167
|
* @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.
|
|
43168
43168
|
* @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.
|
|
43169
43169
|
* @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.
|
|
43170
|
-
* @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
|
|
43170
|
+
* @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
|
|
43171
43171
|
* @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**
|
|
43172
43172
|
* @param {*} [axiosOptions] Override http request option.
|
|
43173
43173
|
* @throws {RequiredError}
|
|
43174
43174
|
*/
|
|
43175
43175
|
listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: 'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score', limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutliersContributingFeatureAccessItemsBeta>>>;
|
|
43176
43176
|
/**
|
|
43177
|
-
* This API receives a list of
|
|
43177
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
|
|
43178
43178
|
* @summary IAI Identity Outliers Unignore
|
|
43179
43179
|
* @param {Array<string>} requestBody
|
|
43180
43180
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43188,7 +43188,7 @@ export declare const IAIOutliersBetaApiFp: (configuration?: Configuration) => {
|
|
|
43188
43188
|
*/
|
|
43189
43189
|
export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
43190
43190
|
/**
|
|
43191
|
-
* 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
|
|
43191
|
+
* 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).
|
|
43192
43192
|
* @summary IAI Identity Outliers Export
|
|
43193
43193
|
* @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
|
|
43194
43194
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43196,7 +43196,7 @@ export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration,
|
|
|
43196
43196
|
*/
|
|
43197
43197
|
exportOutliersZip(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', axiosOptions?: any): AxiosPromise<any>;
|
|
43198
43198
|
/**
|
|
43199
|
-
* This API
|
|
43199
|
+
* This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
|
|
43200
43200
|
* @summary IAI Identity Outliers Summary
|
|
43201
43201
|
* @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.
|
|
43202
43202
|
* @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.
|
|
@@ -43208,7 +43208,7 @@ export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration,
|
|
|
43208
43208
|
*/
|
|
43209
43209
|
getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<OutlierSummaryBeta>>;
|
|
43210
43210
|
/**
|
|
43211
|
-
* This API
|
|
43211
|
+
* 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.
|
|
43212
43212
|
* @summary IAI Get Identity Outliers
|
|
43213
43213
|
* @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.
|
|
43214
43214
|
* @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.
|
|
@@ -43221,7 +43221,7 @@ export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration,
|
|
|
43221
43221
|
*/
|
|
43222
43222
|
getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<OutlierBeta>>;
|
|
43223
43223
|
/**
|
|
43224
|
-
* This API returns a most recent snapshot of each outlier type, each containing
|
|
43224
|
+
* 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.
|
|
43225
43225
|
* @summary IAI Identity Outliers Latest Summary
|
|
43226
43226
|
* @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
|
|
43227
43227
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43229,7 +43229,7 @@ export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration,
|
|
|
43229
43229
|
*/
|
|
43230
43230
|
getLatestIdentityOutlierSnapshots(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', axiosOptions?: any): AxiosPromise<Array<LatestOutlierSummaryBeta>>;
|
|
43231
43231
|
/**
|
|
43232
|
-
* This API returns a summary of a contributing feature for an identity outlier.
|
|
43232
|
+
* 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.
|
|
43233
43233
|
* @summary Get identity outlier contibuting feature summary
|
|
43234
43234
|
* @param {string} outlierFeatureId Contributing feature id
|
|
43235
43235
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43237,7 +43237,7 @@ export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration,
|
|
|
43237
43237
|
*/
|
|
43238
43238
|
getOutlierContributingFeatureSummary(outlierFeatureId: string, axiosOptions?: any): AxiosPromise<OutlierFeatureSummaryBeta>;
|
|
43239
43239
|
/**
|
|
43240
|
-
* This API returns a list of contributing feature objects for a single outlier.
|
|
43240
|
+
* 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.
|
|
43241
43241
|
* @summary Get identity outlier\'s contibuting features
|
|
43242
43242
|
* @param {string} outlierId The outlier id
|
|
43243
43243
|
* @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.
|
|
@@ -43250,7 +43250,7 @@ export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration,
|
|
|
43250
43250
|
*/
|
|
43251
43251
|
getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<OutlierContributingFeatureBeta>>;
|
|
43252
43252
|
/**
|
|
43253
|
-
* This API receives a list of
|
|
43253
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be ignored.
|
|
43254
43254
|
* @summary IAI Identity Outliers Ignore
|
|
43255
43255
|
* @param {Array<string>} requestBody
|
|
43256
43256
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43258,21 +43258,21 @@ export declare const IAIOutliersBetaApiFactory: (configuration?: Configuration,
|
|
|
43258
43258
|
*/
|
|
43259
43259
|
ignoreIdentityOutliers(requestBody: Array<string>, axiosOptions?: any): AxiosPromise<void>;
|
|
43260
43260
|
/**
|
|
43261
|
-
* 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
|
|
43261
|
+
* 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.
|
|
43262
43262
|
* @summary Gets a list of access items associated with each identity outlier contributing feature
|
|
43263
43263
|
* @param {string} outlierId The outlier id
|
|
43264
43264
|
* @param {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} contributingFeatureName The name of contributing feature
|
|
43265
43265
|
* @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.
|
|
43266
43266
|
* @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.
|
|
43267
43267
|
* @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.
|
|
43268
|
-
* @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
|
|
43268
|
+
* @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
|
|
43269
43269
|
* @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**
|
|
43270
43270
|
* @param {*} [axiosOptions] Override http request option.
|
|
43271
43271
|
* @throws {RequiredError}
|
|
43272
43272
|
*/
|
|
43273
43273
|
listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: 'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score', limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<OutliersContributingFeatureAccessItemsBeta>>;
|
|
43274
43274
|
/**
|
|
43275
|
-
* This API receives a list of
|
|
43275
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
|
|
43276
43276
|
* @summary IAI Identity Outliers Unignore
|
|
43277
43277
|
* @param {Array<string>} requestBody
|
|
43278
43278
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43492,7 +43492,7 @@ export interface IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsReq
|
|
|
43492
43492
|
*/
|
|
43493
43493
|
readonly count?: boolean;
|
|
43494
43494
|
/**
|
|
43495
|
-
* The type of access item for the identity outlier contributing feature. If not provided, it returns all
|
|
43495
|
+
* The type of access item for the identity outlier contributing feature. If not provided, it returns all.
|
|
43496
43496
|
* @type {string}
|
|
43497
43497
|
* @memberof IAIOutliersBetaApiListOutliersContributingFeatureAccessItems
|
|
43498
43498
|
*/
|
|
@@ -43525,7 +43525,7 @@ export interface IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest {
|
|
|
43525
43525
|
*/
|
|
43526
43526
|
export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
43527
43527
|
/**
|
|
43528
|
-
* 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
|
|
43528
|
+
* 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).
|
|
43529
43529
|
* @summary IAI Identity Outliers Export
|
|
43530
43530
|
* @param {IAIOutliersBetaApiExportOutliersZipRequest} requestParameters Request parameters.
|
|
43531
43531
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43534,7 +43534,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43534
43534
|
*/
|
|
43535
43535
|
exportOutliersZip(requestParameters?: IAIOutliersBetaApiExportOutliersZipRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
43536
43536
|
/**
|
|
43537
|
-
* This API
|
|
43537
|
+
* This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
|
|
43538
43538
|
* @summary IAI Identity Outliers Summary
|
|
43539
43539
|
* @param {IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
|
|
43540
43540
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43543,7 +43543,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43543
43543
|
*/
|
|
43544
43544
|
getIdentityOutlierSnapshots(requestParameters?: IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierSummaryBeta[], any>>;
|
|
43545
43545
|
/**
|
|
43546
|
-
* This API
|
|
43546
|
+
* 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.
|
|
43547
43547
|
* @summary IAI Get Identity Outliers
|
|
43548
43548
|
* @param {IAIOutliersBetaApiGetIdentityOutliersRequest} requestParameters Request parameters.
|
|
43549
43549
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43552,7 +43552,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43552
43552
|
*/
|
|
43553
43553
|
getIdentityOutliers(requestParameters?: IAIOutliersBetaApiGetIdentityOutliersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierBeta[], any>>;
|
|
43554
43554
|
/**
|
|
43555
|
-
* This API returns a most recent snapshot of each outlier type, each containing
|
|
43555
|
+
* 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.
|
|
43556
43556
|
* @summary IAI Identity Outliers Latest Summary
|
|
43557
43557
|
* @param {IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
|
|
43558
43558
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43561,7 +43561,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43561
43561
|
*/
|
|
43562
43562
|
getLatestIdentityOutlierSnapshots(requestParameters?: IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LatestOutlierSummaryBeta[], any>>;
|
|
43563
43563
|
/**
|
|
43564
|
-
* This API returns a summary of a contributing feature for an identity outlier.
|
|
43564
|
+
* 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.
|
|
43565
43565
|
* @summary Get identity outlier contibuting feature summary
|
|
43566
43566
|
* @param {IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters.
|
|
43567
43567
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43570,7 +43570,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43570
43570
|
*/
|
|
43571
43571
|
getOutlierContributingFeatureSummary(requestParameters: IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierFeatureSummaryBeta, any>>;
|
|
43572
43572
|
/**
|
|
43573
|
-
* This API returns a list of contributing feature objects for a single outlier.
|
|
43573
|
+
* 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.
|
|
43574
43574
|
* @summary Get identity outlier\'s contibuting features
|
|
43575
43575
|
* @param {IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters.
|
|
43576
43576
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43579,7 +43579,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43579
43579
|
*/
|
|
43580
43580
|
getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierContributingFeatureBeta[], any>>;
|
|
43581
43581
|
/**
|
|
43582
|
-
* This API receives a list of
|
|
43582
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be ignored.
|
|
43583
43583
|
* @summary IAI Identity Outliers Ignore
|
|
43584
43584
|
* @param {IAIOutliersBetaApiIgnoreIdentityOutliersRequest} requestParameters Request parameters.
|
|
43585
43585
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43588,7 +43588,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43588
43588
|
*/
|
|
43589
43589
|
ignoreIdentityOutliers(requestParameters: IAIOutliersBetaApiIgnoreIdentityOutliersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
43590
43590
|
/**
|
|
43591
|
-
* 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
|
|
43591
|
+
* 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.
|
|
43592
43592
|
* @summary Gets a list of access items associated with each identity outlier contributing feature
|
|
43593
43593
|
* @param {IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters.
|
|
43594
43594
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43597,7 +43597,7 @@ export declare class IAIOutliersBetaApi extends BaseAPI {
|
|
|
43597
43597
|
*/
|
|
43598
43598
|
listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutliersContributingFeatureAccessItemsBeta[], any>>;
|
|
43599
43599
|
/**
|
|
43600
|
-
* This API receives a list of
|
|
43600
|
+
* This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
|
|
43601
43601
|
* @summary IAI Identity Outliers Unignore
|
|
43602
43602
|
* @param {IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters.
|
|
43603
43603
|
* @param {*} [axiosOptions] Override http request option.
|