/** * Identity Security Cloud API - IAI Peer Group Strategies * 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 type { RequestArgs } from './base'; import { BaseAPI } 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 GetPeerGroupOutliersV1401Response */ export interface GetPeerGroupOutliersV1401Response { /** * A message describing the error * @type {any} * @memberof GetPeerGroupOutliersV1401Response */ 'error'?: any; } /** * * @export * @interface GetPeerGroupOutliersV1429Response */ export interface GetPeerGroupOutliersV1429Response { /** * A message describing the error * @type {any} * @memberof GetPeerGroupOutliersV1429Response */ 'message'?: any; } /** * 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 declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface PeerGroupMember */ export interface PeerGroupMember { /** * A unique identifier for the peer group member. * @type {string} * @memberof PeerGroupMember */ 'id'?: string; /** * The type of the peer group member. * @type {string} * @memberof PeerGroupMember */ 'type'?: string; /** * The ID of the peer group. * @type {string} * @memberof PeerGroupMember */ 'peer_group_id'?: string; /** * Arbitrary key-value pairs, belonging to the peer group member. * @type {{ [key: string]: object; }} * @memberof PeerGroupMember */ 'attributes'?: { [key: string]: object; }; } /** * IAIPeerGroupStrategiesApi - axios parameter creator * @export */ export declare const IAIPeerGroupStrategiesApiAxiosParamCreator: (configuration?: Configuration) => { /** * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. * @summary Identity outliers list * @param {GetPeerGroupOutliersV1StrategyEnum} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. * @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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getPeerGroupOutliersV1: (strategy: GetPeerGroupOutliersV1StrategyEnum, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * IAIPeerGroupStrategiesApi - functional programming interface * @export */ export declare const IAIPeerGroupStrategiesApiFp: (configuration?: Configuration) => { /** * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. * @summary Identity outliers list * @param {GetPeerGroupOutliersV1StrategyEnum} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. * @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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getPeerGroupOutliersV1(strategy: GetPeerGroupOutliersV1StrategyEnum, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * IAIPeerGroupStrategiesApi - factory interface * @export */ export declare const IAIPeerGroupStrategiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. * @summary Identity outliers list * @param {IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getPeerGroupOutliersV1(requestParameters: IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for getPeerGroupOutliersV1 operation in IAIPeerGroupStrategiesApi. * @export * @interface IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1Request */ export interface IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1Request { /** * The strategy used to create peer groups. Currently, \'entitlement\' is supported. * @type {'entitlement'} * @memberof IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1 */ readonly strategy: GetPeerGroupOutliersV1StrategyEnum; /** * 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 IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1 */ 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 IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1 */ 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 IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1 */ readonly xSailPointExperimental?: string; } /** * IAIPeerGroupStrategiesApi - object-oriented interface * @export * @class IAIPeerGroupStrategiesApi * @extends {BaseAPI} */ export declare class IAIPeerGroupStrategiesApi extends BaseAPI { /** * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. * @summary Identity outliers list * @param {IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof IAIPeerGroupStrategiesApi */ getPeerGroupOutliersV1(requestParameters: IAIPeerGroupStrategiesApiGetPeerGroupOutliersV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetPeerGroupOutliersV1StrategyEnum: { readonly Entitlement: "entitlement"; }; export type GetPeerGroupOutliersV1StrategyEnum = typeof GetPeerGroupOutliersV1StrategyEnum[keyof typeof GetPeerGroupOutliersV1StrategyEnum];