/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Role Insights * 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 CreateRoleInsightRequestsV1401Response */ export interface CreateRoleInsightRequestsV1401Response { /** * A message describing the error * @type {any} * @memberof CreateRoleInsightRequestsV1401Response */ 'error'?: any; } /** * * @export * @interface CreateRoleInsightRequestsV1429Response */ export interface CreateRoleInsightRequestsV1429Response { /** * A message describing the error * @type {any} * @memberof CreateRoleInsightRequestsV1429Response */ 'message'?: any; } /** * * @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; } /** * 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 RoleInsight */ export interface RoleInsight { /** * Insight id * @type {string} * @memberof RoleInsight */ 'id'?: string; /** * Total number of updates for this role * @type {number} * @memberof RoleInsight */ 'numberOfUpdates'?: number; /** * The date-time insights were last created for this role. * @type {string} * @memberof RoleInsight */ 'createdDate'?: string; /** * The date-time insights were last modified for this role. * @type {string} * @memberof RoleInsight */ 'modifiedDate'?: string | null; /** * * @type {RoleInsightsRole} * @memberof RoleInsight */ 'role'?: RoleInsightsRole; /** * * @type {RoleInsightsInsight} * @memberof RoleInsight */ 'insight'?: RoleInsightsInsight; } /** * * @export * @interface RoleInsightsEntitlement */ export interface RoleInsightsEntitlement { /** * Name of the entitlement * @type {string} * @memberof RoleInsightsEntitlement */ 'name'?: string; /** * Id of the entitlement * @type {string} * @memberof RoleInsightsEntitlement */ 'id'?: string; /** * Description for the entitlement * @type {string} * @memberof RoleInsightsEntitlement */ 'description'?: string | null; /** * Source or the application for the entitlement * @type {string} * @memberof RoleInsightsEntitlement */ 'source'?: string; /** * Attribute for the entitlement * @type {string} * @memberof RoleInsightsEntitlement */ 'attribute'?: string; /** * Attribute value for the entitlement * @type {string} * @memberof RoleInsightsEntitlement */ 'value'?: string; } /** * * @export * @interface RoleInsightsEntitlementChanges */ export interface RoleInsightsEntitlementChanges { /** * Name of the entitlement * @type {string} * @memberof RoleInsightsEntitlementChanges */ 'name'?: string; /** * Id of the entitlement * @type {string} * @memberof RoleInsightsEntitlementChanges */ 'id'?: string; /** * Description for the entitlement * @type {string} * @memberof RoleInsightsEntitlementChanges */ 'description'?: string | null; /** * Attribute for the entitlement * @type {string} * @memberof RoleInsightsEntitlementChanges */ 'attribute'?: string; /** * Attribute value for the entitlement * @type {string} * @memberof RoleInsightsEntitlementChanges */ 'value'?: string; /** * Source or the application for the entitlement * @type {string} * @memberof RoleInsightsEntitlementChanges */ 'source'?: string; /** * * @type {RoleInsightsInsight} * @memberof RoleInsightsEntitlementChanges */ 'insight'?: RoleInsightsInsight; } /** * * @export * @interface RoleInsightsIdentities */ export interface RoleInsightsIdentities { /** * Id for identity * @type {string} * @memberof RoleInsightsIdentities */ 'id'?: string; /** * Name for identity * @type {string} * @memberof RoleInsightsIdentities */ 'name'?: string; /** * * @type {{ [key: string]: string; }} * @memberof RoleInsightsIdentities */ 'attributes'?: { [key: string]: string; }; } /** * * @export * @interface RoleInsightsInsight */ export interface RoleInsightsInsight { /** * The number of identities in this role with the entitlement. * @type {string} * @memberof RoleInsightsInsight */ 'type'?: string; /** * The number of identities in this role with the entitlement. * @type {number} * @memberof RoleInsightsInsight */ 'identitiesWithAccess'?: number; /** * The number of identities in this role that do not have the specified entitlement. * @type {number} * @memberof RoleInsightsInsight */ 'identitiesImpacted'?: number; /** * The total number of identities. * @type {number} * @memberof RoleInsightsInsight */ 'totalNumberOfIdentities'?: number; /** * * @type {string} * @memberof RoleInsightsInsight */ 'impactedIdentityNames'?: string | null; } /** * * @export * @interface RoleInsightsResponse */ export interface RoleInsightsResponse { /** * Request Id for a role insight generation request * @type {string} * @memberof RoleInsightsResponse */ 'id'?: string; /** * The date-time role insights request was created. * @type {string} * @memberof RoleInsightsResponse */ 'createdDate'?: string; /** * The date-time role insights request was completed. * @type {string} * @memberof RoleInsightsResponse */ 'lastGenerated'?: string; /** * Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. * @type {number} * @memberof RoleInsightsResponse */ 'numberOfUpdates'?: number; /** * The role IDs that are in this request. * @type {Array} * @memberof RoleInsightsResponse */ 'roleIds'?: Array; /** * Request status * @type {string} * @memberof RoleInsightsResponse */ 'status'?: RoleInsightsResponseStatusEnum; } export const RoleInsightsResponseStatusEnum = { Created: 'CREATED', InProgress: 'IN PROGRESS', Completed: 'COMPLETED', Failed: 'FAILED' } as const; export type RoleInsightsResponseStatusEnum = typeof RoleInsightsResponseStatusEnum[keyof typeof RoleInsightsResponseStatusEnum]; /** * * @export * @interface RoleInsightsRole */ export interface RoleInsightsRole { /** * Role name * @type {string} * @memberof RoleInsightsRole */ 'name'?: string; /** * Role id * @type {string} * @memberof RoleInsightsRole */ 'id'?: string; /** * Role description * @type {string} * @memberof RoleInsightsRole */ 'description'?: string; /** * Role owner name * @type {string} * @memberof RoleInsightsRole */ 'ownerName'?: string; /** * Role owner id * @type {string} * @memberof RoleInsightsRole */ 'ownerId'?: string; } /** * * @export * @interface RoleInsightsSummary */ export interface RoleInsightsSummary { /** * Total number of roles with updates * @type {number} * @memberof RoleInsightsSummary */ 'numberOfUpdates'?: number; /** * The date-time role insights were last found. * @type {string} * @memberof RoleInsightsSummary */ 'lastGenerated'?: string; /** * The number of entitlements included in roles (vs free radicals). * @type {number} * @memberof RoleInsightsSummary */ 'entitlementsIncludedInRoles'?: number; /** * The total number of entitlements. * @type {number} * @memberof RoleInsightsSummary */ 'totalNumberOfEntitlements'?: number; /** * The number of identities in roles vs. identities with just entitlements and not in roles. * @type {number} * @memberof RoleInsightsSummary */ 'identitiesWithAccessViaRoles'?: number; /** * The total number of identities. * @type {number} * @memberof RoleInsightsSummary */ 'totalNumberOfIdentities'?: number; } /** * RoleInsightsApi - axios parameter creator * @export */ export const RoleInsightsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. * @summary Generate insights for roles * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ createRoleInsightRequestsV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/requests`; // 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; 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 endpoint returns the entitlement insights for a role. * @summary Download entitlement insights for a role * @param {string} insightId The role insight id * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. * @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: **name**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ downloadRoleInsightsEntitlementsChangesV1: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'insightId' is not null or undefined assertParamExists('downloadRoleInsightsEntitlementsChangesV1', 'insightId', insightId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/{insightId}/entitlement-changes/download` .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); // 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 (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } 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, }; }, /** * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. * @summary Get identities for a suggested entitlement (for a role) * @param {string} insightId The role insight id * @param {string} entitlementId The entitlement id * @param {boolean} [hasEntitlement] Identity has this entitlement or not * @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 {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 {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} [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: **name** * @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: **name**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementChangesIdentitiesV1: async (insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'insightId' is not null or undefined assertParamExists('getEntitlementChangesIdentitiesV1', 'insightId', insightId) // verify required parameter 'entitlementId' is not null or undefined assertParamExists('getEntitlementChangesIdentitiesV1', 'entitlementId', entitlementId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/{insightId}/entitlement-changes/{entitlementId}/identities` .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))) .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); // 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 (hasEntitlement !== undefined) { localVarQueryParameter['hasEntitlement'] = hasEntitlement; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } 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 endpoint gets role insights information for a role. * @summary Get a single role insight * @param {string} insightId The role insight id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightV1: async (insightId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'insightId' is not null or undefined assertParamExists('getRoleInsightV1', 'insightId', insightId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/{insightId}` .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); // 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 endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. * @summary Get current entitlement for a role * @param {string} insightId The role insight id * @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: **name**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsCurrentEntitlementsV1: async (insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'insightId' is not null or undefined assertParamExists('getRoleInsightsCurrentEntitlementsV1', 'insightId', insightId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/{insightId}/current-entitlements` .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); // 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 (filters !== undefined) { localVarQueryParameter['filters'] = filters; } 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 endpoint returns entitlement insights for a role. * @summary Get entitlement insights for a role * @param {string} insightId The role insight id * @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: **identitiesWithAccess, name** * @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: **name**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsEntitlementsChangesV1: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'insightId' is not null or undefined assertParamExists('getRoleInsightsEntitlementsChangesV1', 'insightId', insightId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/{insightId}/entitlement-changes` .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); // 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 (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } 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 endpoint returns details of a prior role insights request. * @summary Returns metadata from prior request. * @param {string} id The role insights request id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getRoleInsightsRequestsV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getRoleInsightsRequestsV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/requests/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // 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 method returns high level summary information for role insights for a customer. * @summary Get role insights summary information * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsSummaryV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/v1/summary`; // 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 method returns detailed role insights for each role. * @summary Get role insights * @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 {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 {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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** * @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: **name**: *sw* **ownerName**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsV1: async (offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/role-insights/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 (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } 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, }; }, } }; /** * RoleInsightsApi - functional programming interface * @export */ export const RoleInsightsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = RoleInsightsApiAxiosParamCreator(configuration) return { /** * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. * @summary Generate insights for roles * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ async createRoleInsightRequestsV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleInsightRequestsV1(xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.createRoleInsightRequestsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This endpoint returns the entitlement insights for a role. * @summary Download entitlement insights for a role * @param {string} insightId The role insight id * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. * @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: **name**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async downloadRoleInsightsEntitlementsChangesV1(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleInsightsEntitlementsChangesV1(insightId, sorters, filters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.downloadRoleInsightsEntitlementsChangesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. * @summary Get identities for a suggested entitlement (for a role) * @param {string} insightId The role insight id * @param {string} entitlementId The entitlement id * @param {boolean} [hasEntitlement] Identity has this entitlement or not * @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 {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 {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} [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: **name** * @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: **name**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getEntitlementChangesIdentitiesV1(insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementChangesIdentitiesV1(insightId, entitlementId, hasEntitlement, offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.getEntitlementChangesIdentitiesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This endpoint gets role insights information for a role. * @summary Get a single role insight * @param {string} insightId The role insight id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getRoleInsightV1(insightId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightV1(insightId, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.getRoleInsightV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. * @summary Get current entitlement for a role * @param {string} insightId The role insight id * @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: **name**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getRoleInsightsCurrentEntitlementsV1(insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsCurrentEntitlementsV1(insightId, filters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.getRoleInsightsCurrentEntitlementsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This endpoint returns entitlement insights for a role. * @summary Get entitlement insights for a role * @param {string} insightId The role insight id * @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: **identitiesWithAccess, name** * @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: **name**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getRoleInsightsEntitlementsChangesV1(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsEntitlementsChangesV1(insightId, sorters, filters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.getRoleInsightsEntitlementsChangesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This endpoint returns details of a prior role insights request. * @summary Returns metadata from prior request. * @param {string} id The role insights request id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ async getRoleInsightsRequestsV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsRequestsV1(id, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.getRoleInsightsRequestsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method returns high level summary information for role insights for a customer. * @summary Get role insights summary information * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getRoleInsightsSummaryV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsSummaryV1(xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.getRoleInsightsSummaryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method returns detailed role insights for each role. * @summary Get role insights * @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 {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 {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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** * @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: **name**: *sw* **ownerName**: *sw* **description**: *sw* * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getRoleInsightsV1(offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsV1(offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['RoleInsightsApi.getRoleInsightsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * RoleInsightsApi - factory interface * @export */ export const RoleInsightsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = RoleInsightsApiFp(configuration) return { /** * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. * @summary Generate insights for roles * @param {RoleInsightsApiCreateRoleInsightRequestsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ createRoleInsightRequestsV1(requestParameters: RoleInsightsApiCreateRoleInsightRequestsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createRoleInsightRequestsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This endpoint returns the entitlement insights for a role. * @summary Download entitlement insights for a role * @param {RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ downloadRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.downloadRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. * @summary Get identities for a suggested entitlement (for a role) * @param {RoleInsightsApiGetEntitlementChangesIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementChangesIdentitiesV1(requestParameters: RoleInsightsApiGetEntitlementChangesIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getEntitlementChangesIdentitiesV1(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This endpoint gets role insights information for a role. * @summary Get a single role insight * @param {RoleInsightsApiGetRoleInsightV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightV1(requestParameters: RoleInsightsApiGetRoleInsightV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getRoleInsightV1(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. * @summary Get current entitlement for a role * @param {RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsCurrentEntitlementsV1(requestParameters: RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getRoleInsightsCurrentEntitlementsV1(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This endpoint returns entitlement insights for a role. * @summary Get entitlement insights for a role * @param {RoleInsightsApiGetRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsApiGetRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This endpoint returns details of a prior role insights request. * @summary Returns metadata from prior request. * @param {RoleInsightsApiGetRoleInsightsRequestsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getRoleInsightsRequestsV1(requestParameters: RoleInsightsApiGetRoleInsightsRequestsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getRoleInsightsRequestsV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method returns high level summary information for role insights for a customer. * @summary Get role insights summary information * @param {RoleInsightsApiGetRoleInsightsSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsSummaryV1(requestParameters: RoleInsightsApiGetRoleInsightsSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getRoleInsightsSummaryV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method returns detailed role insights for each role. * @summary Get role insights * @param {RoleInsightsApiGetRoleInsightsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleInsightsV1(requestParameters: RoleInsightsApiGetRoleInsightsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getRoleInsightsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createRoleInsightRequestsV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiCreateRoleInsightRequestsV1Request */ export interface RoleInsightsApiCreateRoleInsightRequestsV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiCreateRoleInsightRequestsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for downloadRoleInsightsEntitlementsChangesV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1Request */ export interface RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1Request { /** * The role insight id * @type {string} * @memberof RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1 */ readonly insightId: 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. * @type {string} * @memberof RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1 */ readonly sorters?: string /** * 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: **name**: *sw* **description**: *sw* * @type {string} * @memberof RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1 */ readonly filters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getEntitlementChangesIdentitiesV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiGetEntitlementChangesIdentitiesV1Request */ export interface RoleInsightsApiGetEntitlementChangesIdentitiesV1Request { /** * The role insight id * @type {string} * @memberof RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly insightId: string /** * The entitlement id * @type {string} * @memberof RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly entitlementId: string /** * Identity has this entitlement or not * @type {boolean} * @memberof RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly hasEntitlement?: boolean /** * 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 RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly offset?: number /** * 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 RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly limit?: 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 RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly count?: boolean /** * 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: **name** * @type {string} * @memberof RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly sorters?: string /** * 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: **name**: *sw* * @type {string} * @memberof RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly filters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiGetEntitlementChangesIdentitiesV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getRoleInsightV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiGetRoleInsightV1Request */ export interface RoleInsightsApiGetRoleInsightV1Request { /** * The role insight id * @type {string} * @memberof RoleInsightsApiGetRoleInsightV1 */ readonly insightId: string /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiGetRoleInsightV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getRoleInsightsCurrentEntitlementsV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1Request */ export interface RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1Request { /** * The role insight id * @type {string} * @memberof RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1 */ readonly insightId: string /** * 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: **name**: *sw* **description**: *sw* * @type {string} * @memberof RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1 */ readonly filters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getRoleInsightsEntitlementsChangesV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiGetRoleInsightsEntitlementsChangesV1Request */ export interface RoleInsightsApiGetRoleInsightsEntitlementsChangesV1Request { /** * The role insight id * @type {string} * @memberof RoleInsightsApiGetRoleInsightsEntitlementsChangesV1 */ readonly insightId: 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: **identitiesWithAccess, name** * @type {string} * @memberof RoleInsightsApiGetRoleInsightsEntitlementsChangesV1 */ readonly sorters?: string /** * 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: **name**: *sw* **description**: *sw* * @type {string} * @memberof RoleInsightsApiGetRoleInsightsEntitlementsChangesV1 */ readonly filters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiGetRoleInsightsEntitlementsChangesV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getRoleInsightsRequestsV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiGetRoleInsightsRequestsV1Request */ export interface RoleInsightsApiGetRoleInsightsRequestsV1Request { /** * The role insights request id * @type {string} * @memberof RoleInsightsApiGetRoleInsightsRequestsV1 */ readonly id: string /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiGetRoleInsightsRequestsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getRoleInsightsSummaryV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiGetRoleInsightsSummaryV1Request */ export interface RoleInsightsApiGetRoleInsightsSummaryV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiGetRoleInsightsSummaryV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getRoleInsightsV1 operation in RoleInsightsApi. * @export * @interface RoleInsightsApiGetRoleInsightsV1Request */ export interface RoleInsightsApiGetRoleInsightsV1Request { /** * 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 RoleInsightsApiGetRoleInsightsV1 */ readonly offset?: number /** * 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 RoleInsightsApiGetRoleInsightsV1 */ readonly limit?: 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 RoleInsightsApiGetRoleInsightsV1 */ readonly count?: boolean /** * 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** * @type {string} * @memberof RoleInsightsApiGetRoleInsightsV1 */ readonly sorters?: string /** * 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* * @type {string} * @memberof RoleInsightsApiGetRoleInsightsV1 */ readonly filters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof RoleInsightsApiGetRoleInsightsV1 */ readonly xSailPointExperimental?: string } /** * RoleInsightsApi - object-oriented interface * @export * @class RoleInsightsApi * @extends {BaseAPI} */ export class RoleInsightsApi extends BaseAPI { /** * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. * @summary Generate insights for roles * @param {RoleInsightsApiCreateRoleInsightRequestsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof RoleInsightsApi */ public createRoleInsightRequestsV1(requestParameters: RoleInsightsApiCreateRoleInsightRequestsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).createRoleInsightRequestsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This endpoint returns the entitlement insights for a role. * @summary Download entitlement insights for a role * @param {RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleInsightsApi */ public downloadRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsApiDownloadRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).downloadRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. * @summary Get identities for a suggested entitlement (for a role) * @param {RoleInsightsApiGetEntitlementChangesIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleInsightsApi */ public getEntitlementChangesIdentitiesV1(requestParameters: RoleInsightsApiGetEntitlementChangesIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).getEntitlementChangesIdentitiesV1(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This endpoint gets role insights information for a role. * @summary Get a single role insight * @param {RoleInsightsApiGetRoleInsightV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleInsightsApi */ public getRoleInsightV1(requestParameters: RoleInsightsApiGetRoleInsightV1Request, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).getRoleInsightV1(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. * @summary Get current entitlement for a role * @param {RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleInsightsApi */ public getRoleInsightsCurrentEntitlementsV1(requestParameters: RoleInsightsApiGetRoleInsightsCurrentEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).getRoleInsightsCurrentEntitlementsV1(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This endpoint returns entitlement insights for a role. * @summary Get entitlement insights for a role * @param {RoleInsightsApiGetRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleInsightsApi */ public getRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsApiGetRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).getRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This endpoint returns details of a prior role insights request. * @summary Returns metadata from prior request. * @param {RoleInsightsApiGetRoleInsightsRequestsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof RoleInsightsApi */ public getRoleInsightsRequestsV1(requestParameters: RoleInsightsApiGetRoleInsightsRequestsV1Request, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).getRoleInsightsRequestsV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method returns high level summary information for role insights for a customer. * @summary Get role insights summary information * @param {RoleInsightsApiGetRoleInsightsSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleInsightsApi */ public getRoleInsightsSummaryV1(requestParameters: RoleInsightsApiGetRoleInsightsSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).getRoleInsightsSummaryV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method returns detailed role insights for each role. * @summary Get role insights * @param {RoleInsightsApiGetRoleInsightsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleInsightsApi */ public getRoleInsightsV1(requestParameters: RoleInsightsApiGetRoleInsightsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return RoleInsightsApiFp(this.configuration).getRoleInsightsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } }