/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Identity Profiles * 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 ArrayInner */ export interface ArrayInner { } /** * * @export * @interface BaseCommonDto */ export interface BaseCommonDto { /** * System-generated unique ID of the Object * @type {string} * @memberof BaseCommonDto */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof BaseCommonDto */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof BaseCommonDto */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof BaseCommonDto */ 'modified'?: string; } /** * * @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; } /** * Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. * @export * @interface IdentityAttributeConfig */ export interface IdentityAttributeConfig { /** * Backend will only promote values if the profile/mapping is enabled. * @type {boolean} * @memberof IdentityAttributeConfig */ 'enabled'?: boolean; /** * * @type {Array} * @memberof IdentityAttributeConfig */ 'attributeTransforms'?: Array; } /** * * @export * @interface IdentityAttributePreview */ export interface IdentityAttributePreview { /** * Name of the attribute that is being previewed. * @type {string} * @memberof IdentityAttributePreview */ 'name'?: string; /** * Value that was derived during the preview. * @type {string} * @memberof IdentityAttributePreview */ 'value'?: string; /** * The value of the attribute before the preview. * @type {string} * @memberof IdentityAttributePreview */ 'previousValue'?: string; /** * List of error messages * @type {Array} * @memberof IdentityAttributePreview */ 'errorMessages'?: Array; } /** * Transform definition for an identity attribute. * @export * @interface IdentityAttributeTransform */ export interface IdentityAttributeTransform { /** * Identity attribute\'s name. * @type {string} * @memberof IdentityAttributeTransform */ 'identityAttributeName'?: string; /** * * @type {TransformDefinition} * @memberof IdentityAttributeTransform */ 'transformDefinition'?: TransformDefinition; } /** * * @export * @interface IdentityExceptionReportReference */ export interface IdentityExceptionReportReference { /** * Task result ID. * @type {string} * @memberof IdentityExceptionReportReference */ 'taskResultId'?: string; /** * Report name. * @type {string} * @memberof IdentityExceptionReportReference */ 'reportName'?: string; } /** * * @export * @interface IdentityPreviewRequest */ export interface IdentityPreviewRequest { /** * The Identity id * @type {string} * @memberof IdentityPreviewRequest */ 'identityId'?: string; /** * * @type {IdentityAttributeConfig} * @memberof IdentityPreviewRequest */ 'identityAttributeConfig'?: IdentityAttributeConfig; } /** * * @export * @interface IdentityPreviewResponse */ export interface IdentityPreviewResponse { /** * * @type {IdentityPreviewResponseIdentity} * @memberof IdentityPreviewResponse */ 'identity'?: IdentityPreviewResponseIdentity; /** * * @type {Array} * @memberof IdentityPreviewResponse */ 'previewAttributes'?: Array; } /** * Identity\'s basic details. * @export * @interface IdentityPreviewResponseIdentity */ export interface IdentityPreviewResponseIdentity { /** * Identity\'s DTO type. * @type {string} * @memberof IdentityPreviewResponseIdentity */ 'type'?: IdentityPreviewResponseIdentityTypeEnum; /** * Identity ID. * @type {string} * @memberof IdentityPreviewResponseIdentity */ 'id'?: string; /** * Identity\'s display name. * @type {string} * @memberof IdentityPreviewResponseIdentity */ 'name'?: string; } export const IdentityPreviewResponseIdentityTypeEnum = { Identity: 'IDENTITY' } as const; export type IdentityPreviewResponseIdentityTypeEnum = typeof IdentityPreviewResponseIdentityTypeEnum[keyof typeof IdentityPreviewResponseIdentityTypeEnum]; /** * * @export * @interface IdentityProfile */ export interface IdentityProfile { /** * System-generated unique ID of the Object * @type {string} * @memberof IdentityProfile */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof IdentityProfile */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof IdentityProfile */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof IdentityProfile */ 'modified'?: string; /** * Identity profile\'s description. * @type {string} * @memberof IdentityProfile */ 'description'?: string | null; /** * * @type {IdentityProfileAllOfOwner} * @memberof IdentityProfile */ 'owner'?: IdentityProfileAllOfOwner | null; /** * Identity profile\'s priority. * @type {number} * @memberof IdentityProfile */ 'priority'?: number; /** * * @type {IdentityProfileAllOfAuthoritativeSource} * @memberof IdentityProfile */ 'authoritativeSource': IdentityProfileAllOfAuthoritativeSource; /** * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. * @type {boolean} * @memberof IdentityProfile */ 'identityRefreshRequired'?: boolean; /** * Number of identities belonging to the identity profile. * @type {number} * @memberof IdentityProfile */ 'identityCount'?: number; /** * * @type {IdentityAttributeConfig} * @memberof IdentityProfile */ 'identityAttributeConfig'?: IdentityAttributeConfig; /** * * @type {IdentityExceptionReportReference} * @memberof IdentityProfile */ 'identityExceptionReportReference'?: IdentityExceptionReportReference | null; /** * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. * @type {boolean} * @memberof IdentityProfile */ 'hasTimeBasedAttr'?: boolean; } /** * * @export * @interface IdentityProfileAllOfAuthoritativeSource */ export interface IdentityProfileAllOfAuthoritativeSource { /** * Authoritative source\'s object type. * @type {string} * @memberof IdentityProfileAllOfAuthoritativeSource */ 'type'?: IdentityProfileAllOfAuthoritativeSourceTypeEnum; /** * Authoritative source\'s ID. * @type {string} * @memberof IdentityProfileAllOfAuthoritativeSource */ 'id'?: string; /** * Authoritative source\'s name. * @type {string} * @memberof IdentityProfileAllOfAuthoritativeSource */ 'name'?: string; } export const IdentityProfileAllOfAuthoritativeSourceTypeEnum = { Source: 'SOURCE' } as const; export type IdentityProfileAllOfAuthoritativeSourceTypeEnum = typeof IdentityProfileAllOfAuthoritativeSourceTypeEnum[keyof typeof IdentityProfileAllOfAuthoritativeSourceTypeEnum]; /** * Identity profile\'s owner. * @export * @interface IdentityProfileAllOfOwner */ export interface IdentityProfileAllOfOwner { /** * Owner\'s object type. * @type {string} * @memberof IdentityProfileAllOfOwner */ 'type'?: IdentityProfileAllOfOwnerTypeEnum; /** * Owner\'s ID. * @type {string} * @memberof IdentityProfileAllOfOwner */ 'id'?: string; /** * Owner\'s name. * @type {string} * @memberof IdentityProfileAllOfOwner */ 'name'?: string; } export const IdentityProfileAllOfOwnerTypeEnum = { Identity: 'IDENTITY' } as const; export type IdentityProfileAllOfOwnerTypeEnum = typeof IdentityProfileAllOfOwnerTypeEnum[keyof typeof IdentityProfileAllOfOwnerTypeEnum]; /** * Identity profile exported object. * @export * @interface IdentityProfileExportedObject */ export interface IdentityProfileExportedObject { /** * Version or object from the target service. * @type {number} * @memberof IdentityProfileExportedObject */ 'version'?: number; /** * * @type {IdentityProfileExportedObjectSelf} * @memberof IdentityProfileExportedObject */ 'self'?: IdentityProfileExportedObjectSelf; /** * * @type {IdentityProfile} * @memberof IdentityProfileExportedObject */ 'object'?: IdentityProfile; } /** * Self block for exported object. * @export * @interface IdentityProfileExportedObjectSelf */ export interface IdentityProfileExportedObjectSelf { /** * Exported object\'s DTO type. * @type {string} * @memberof IdentityProfileExportedObjectSelf */ 'type'?: IdentityProfileExportedObjectSelfTypeEnum; /** * Exported object\'s ID. * @type {string} * @memberof IdentityProfileExportedObjectSelf */ 'id'?: string; /** * Exported object\'s display name. * @type {string} * @memberof IdentityProfileExportedObjectSelf */ 'name'?: string; } export const IdentityProfileExportedObjectSelfTypeEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', FormDefinition: 'FORM_DEFINITION', GovernanceGroup: 'GOVERNANCE_GROUP', IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', IdentityProfile: 'IDENTITY_PROFILE', LifecycleState: 'LIFECYCLE_STATE', NotificationTemplate: 'NOTIFICATION_TEMPLATE', PasswordPolicy: 'PASSWORD_POLICY', PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', Role: 'ROLE', Rule: 'RULE', Segment: 'SEGMENT', ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', SodPolicy: 'SOD_POLICY', Source: 'SOURCE', Tag: 'TAG', Transform: 'TRANSFORM', TriggerSubscription: 'TRIGGER_SUBSCRIPTION', Workflow: 'WORKFLOW' } as const; export type IdentityProfileExportedObjectSelfTypeEnum = typeof IdentityProfileExportedObjectSelfTypeEnum[keyof typeof IdentityProfileExportedObjectSelfTypeEnum]; /** * Object created or updated by import. * @export * @interface ImportObject */ export interface ImportObject { /** * DTO type of object created or updated by import. * @type {string} * @memberof ImportObject */ 'type'?: ImportObjectTypeEnum; /** * ID of object created or updated by import. * @type {string} * @memberof ImportObject */ 'id'?: string; /** * Display name of object created or updated by import. * @type {string} * @memberof ImportObject */ 'name'?: string; } export const ImportObjectTypeEnum = { ConnectorRule: 'CONNECTOR_RULE', IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', IdentityProfile: 'IDENTITY_PROFILE', Rule: 'RULE', Source: 'SOURCE', Transform: 'TRANSFORM', TriggerSubscription: 'TRIGGER_SUBSCRIPTION' } as const; export type ImportObjectTypeEnum = typeof ImportObjectTypeEnum[keyof typeof ImportObjectTypeEnum]; /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListIdentityProfilesV1401Response */ export interface ListIdentityProfilesV1401Response { /** * A message describing the error * @type {any} * @memberof ListIdentityProfilesV1401Response */ 'error'?: any; } /** * * @export * @interface ListIdentityProfilesV1429Response */ export interface ListIdentityProfilesV1429Response { /** * A message describing the error * @type {any} * @memberof ListIdentityProfilesV1429Response */ '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 const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * Response model for import of a single object. * @export * @interface ObjectImportResult */ export interface ObjectImportResult { /** * Informational messages returned from the target service on import. * @type {Array} * @memberof ObjectImportResult */ 'infos': Array; /** * Warning messages returned from the target service on import. * @type {Array} * @memberof ObjectImportResult */ 'warnings': Array; /** * Error messages returned from the target service on import. * @type {Array} * @memberof ObjectImportResult */ 'errors': Array; /** * References to objects that were created or updated by the import. * @type {Array} * @memberof ObjectImportResult */ 'importedObjects': Array; } /** * Message model for Config Import/Export. * @export * @interface SpConfigMessage */ export interface SpConfigMessage { /** * Message key. * @type {string} * @memberof SpConfigMessage */ 'key': string; /** * Message text. * @type {string} * @memberof SpConfigMessage */ 'text': string; /** * Message details if any, in key:value pairs. * @type {{ [key: string]: any; }} * @memberof SpConfigMessage */ 'details': { [key: string]: any; }; } /** * * @export * @interface TaskResultSimplified */ export interface TaskResultSimplified { /** * Task identifier * @type {string} * @memberof TaskResultSimplified */ 'id'?: string; /** * Task name * @type {string} * @memberof TaskResultSimplified */ 'name'?: string; /** * Task description * @type {string} * @memberof TaskResultSimplified */ 'description'?: string; /** * User or process who launched the task * @type {string} * @memberof TaskResultSimplified */ 'launcher'?: string; /** * Date time of completion * @type {string} * @memberof TaskResultSimplified */ 'completed'?: string; /** * Date time when the task was launched * @type {string} * @memberof TaskResultSimplified */ 'launched'?: string; /** * Task result status * @type {string} * @memberof TaskResultSimplified */ 'completionStatus'?: TaskResultSimplifiedCompletionStatusEnum; } export const TaskResultSimplifiedCompletionStatusEnum = { Success: 'Success', Warning: 'Warning', Error: 'Error', Terminated: 'Terminated', TempError: 'TempError' } as const; export type TaskResultSimplifiedCompletionStatusEnum = typeof TaskResultSimplifiedCompletionStatusEnum[keyof typeof TaskResultSimplifiedCompletionStatusEnum]; /** * * @export * @interface TransformDefinition */ export interface TransformDefinition { /** * Transform definition type. * @type {string} * @memberof TransformDefinition */ 'type'?: string; /** * Arbitrary key-value pairs to store any metadata for the object * @type {{ [key: string]: any; }} * @memberof TransformDefinition */ 'attributes'?: { [key: string]: any; }; } /** * IdentityProfilesApi - axios parameter creator * @export */ export const IdentityProfilesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Creates an identity profile. * @summary Create identity profile * @param {IdentityProfile} identityProfile * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createIdentityProfileV1: async (identityProfile: IdentityProfile, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityProfile' is not null or undefined assertParamExists('createIdentityProfileV1', 'identityProfile', identityProfile) const localVarPath = `/identity-profiles/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: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(identityProfile, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. * @summary Delete identity profile * @param {string} identityProfileId Identity profile ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteIdentityProfileV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityProfileId' is not null or undefined assertParamExists('deleteIdentityProfileV1', 'identityProfileId', identityProfileId) const localVarPath = `/identity-profiles/v1/{identity-profile-id}` .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); // 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: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete * @summary Delete identity profiles * @param {Array} requestBody Identity Profile bulk delete request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteIdentityProfilesV1: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'requestBody' is not null or undefined assertParamExists('deleteIdentityProfilesV1', 'requestBody', requestBody) const localVarPath = `/identity-profiles/v1/bulk-delete`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This exports existing identity profiles in the format specified by the sp-config service. * @summary Export identity profiles * @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} [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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* * @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: **id, name, priority** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportIdentityProfilesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/identity-profiles/v1/export`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. * @summary Generate identity profile preview * @param {IdentityPreviewRequest} identityPreviewRequest Identity Preview request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ generateIdentityPreviewV1: async (identityPreviewRequest: IdentityPreviewRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityPreviewRequest' is not null or undefined assertParamExists('generateIdentityPreviewV1', 'identityPreviewRequest', identityPreviewRequest) const localVarPath = `/identity-profiles/v1/identity-preview`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This returns the default identity attribute config. * @summary Get default identity attribute config * @param {string} identityProfileId The Identity Profile ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDefaultIdentityAttributeConfigV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityProfileId' is not null or undefined assertParamExists('getDefaultIdentityAttributeConfigV1', 'identityProfileId', identityProfileId) const localVarPath = `/identity-profiles/v1/{identity-profile-id}/default-identity-attribute-config` .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); // 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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get a single identity profile by ID. * @summary Get identity profile * @param {string} identityProfileId Identity profile ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityProfileV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityProfileId' is not null or undefined assertParamExists('getIdentityProfileV1', 'identityProfileId', identityProfileId) const localVarPath = `/identity-profiles/v1/{identity-profile-id}` .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); // 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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This imports previously exported identity profiles. * @summary Import identity profiles * @param {Array} identityProfileExportedObject Previously exported Identity Profiles. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importIdentityProfilesV1: async (identityProfileExportedObject: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityProfileExportedObject' is not null or undefined assertParamExists('importIdentityProfilesV1', 'identityProfileExportedObject', identityProfileExportedObject) const localVarPath = `/identity-profiles/v1/import`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObject, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get a list of identity profiles, based on the specified query parameters. * @summary List identity profiles * @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} [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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* * @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: **id, name, priority, created, modified, owner.id, owner.name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityProfilesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/identity-profiles/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. * @summary Process identities under profile * @param {string} identityProfileId The Identity Profile ID to be processed * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ syncIdentityProfileV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityProfileId' is not null or undefined assertParamExists('syncIdentityProfileV1', 'identityProfileId', identityProfileId) const localVarPath = `/identity-profiles/v1/{identity-profile-id}/process-identities` .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); // 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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. * @summary Update identity profile * @param {string} identityProfileId Identity profile ID. * @param {Array} jsonPatchOperation List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateIdentityProfileV1: async (identityProfileId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityProfileId' is not null or undefined assertParamExists('updateIdentityProfileV1', 'identityProfileId', identityProfileId) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('updateIdentityProfileV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/identity-profiles/v1/{identity-profile-id}` .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); // 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: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * IdentityProfilesApi - functional programming interface * @export */ export const IdentityProfilesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = IdentityProfilesApiAxiosParamCreator(configuration) return { /** * Creates an identity profile. * @summary Create identity profile * @param {IdentityProfile} identityProfile * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createIdentityProfileV1(identityProfile: IdentityProfile, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityProfileV1(identityProfile, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.createIdentityProfileV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. * @summary Delete identity profile * @param {string} identityProfileId Identity profile ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteIdentityProfileV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfileV1(identityProfileId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.deleteIdentityProfileV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete * @summary Delete identity profiles * @param {Array} requestBody Identity Profile bulk delete request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteIdentityProfilesV1(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfilesV1(requestBody, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.deleteIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This exports existing identity profiles in the format specified by the sp-config service. * @summary Export identity profiles * @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} [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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* * @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: **id, name, priority** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async exportIdentityProfilesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfilesV1(limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.exportIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. * @summary Generate identity profile preview * @param {IdentityPreviewRequest} identityPreviewRequest Identity Preview request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async generateIdentityPreviewV1(identityPreviewRequest: IdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.generateIdentityPreviewV1(identityPreviewRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.generateIdentityPreviewV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This returns the default identity attribute config. * @summary Get default identity attribute config * @param {string} identityProfileId The Identity Profile ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getDefaultIdentityAttributeConfigV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultIdentityAttributeConfigV1(identityProfileId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.getDefaultIdentityAttributeConfigV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a single identity profile by ID. * @summary Get identity profile * @param {string} identityProfileId Identity profile ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityProfileV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityProfileV1(identityProfileId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.getIdentityProfileV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This imports previously exported identity profiles. * @summary Import identity profiles * @param {Array} identityProfileExportedObject Previously exported Identity Profiles. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async importIdentityProfilesV1(identityProfileExportedObject: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.importIdentityProfilesV1(identityProfileExportedObject, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.importIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a list of identity profiles, based on the specified query parameters. * @summary List identity profiles * @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} [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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* * @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: **id, name, priority, created, modified, owner.id, owner.name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listIdentityProfilesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfilesV1(limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.listIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. * @summary Process identities under profile * @param {string} identityProfileId The Identity Profile ID to be processed * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async syncIdentityProfileV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.syncIdentityProfileV1(identityProfileId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.syncIdentityProfileV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. * @summary Update identity profile * @param {string} identityProfileId Identity profile ID. * @param {Array} jsonPatchOperation List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateIdentityProfileV1(identityProfileId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateIdentityProfileV1(identityProfileId, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.updateIdentityProfileV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * IdentityProfilesApi - factory interface * @export */ export const IdentityProfilesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = IdentityProfilesApiFp(configuration) return { /** * Creates an identity profile. * @summary Create identity profile * @param {IdentityProfilesApiCreateIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createIdentityProfileV1(requestParameters: IdentityProfilesApiCreateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createIdentityProfileV1(requestParameters.identityProfile, axiosOptions).then((request) => request(axios, basePath)); }, /** * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. * @summary Delete identity profile * @param {IdentityProfilesApiDeleteIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteIdentityProfileV1(requestParameters: IdentityProfilesApiDeleteIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete * @summary Delete identity profiles * @param {IdentityProfilesApiDeleteIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteIdentityProfilesV1(requestParameters: IdentityProfilesApiDeleteIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteIdentityProfilesV1(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); }, /** * This exports existing identity profiles in the format specified by the sp-config service. * @summary Export identity profiles * @param {IdentityProfilesApiExportIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportIdentityProfilesV1(requestParameters: IdentityProfilesApiExportIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.exportIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. * @summary Generate identity profile preview * @param {IdentityProfilesApiGenerateIdentityPreviewV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ generateIdentityPreviewV1(requestParameters: IdentityProfilesApiGenerateIdentityPreviewV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.generateIdentityPreviewV1(requestParameters.identityPreviewRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * This returns the default identity attribute config. * @summary Get default identity attribute config * @param {IdentityProfilesApiGetDefaultIdentityAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDefaultIdentityAttributeConfigV1(requestParameters: IdentityProfilesApiGetDefaultIdentityAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getDefaultIdentityAttributeConfigV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a single identity profile by ID. * @summary Get identity profile * @param {IdentityProfilesApiGetIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityProfileV1(requestParameters: IdentityProfilesApiGetIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This imports previously exported identity profiles. * @summary Import identity profiles * @param {IdentityProfilesApiImportIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importIdentityProfilesV1(requestParameters: IdentityProfilesApiImportIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.importIdentityProfilesV1(requestParameters.identityProfileExportedObject, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a list of identity profiles, based on the specified query parameters. * @summary List identity profiles * @param {IdentityProfilesApiListIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityProfilesV1(requestParameters: IdentityProfilesApiListIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. * @summary Process identities under profile * @param {IdentityProfilesApiSyncIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ syncIdentityProfileV1(requestParameters: IdentityProfilesApiSyncIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.syncIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); }, /** * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. * @summary Update identity profile * @param {IdentityProfilesApiUpdateIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateIdentityProfileV1(requestParameters: IdentityProfilesApiUpdateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateIdentityProfileV1(requestParameters.identityProfileId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createIdentityProfileV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiCreateIdentityProfileV1Request */ export interface IdentityProfilesApiCreateIdentityProfileV1Request { /** * * @type {IdentityProfile} * @memberof IdentityProfilesApiCreateIdentityProfileV1 */ readonly identityProfile: IdentityProfile } /** * Request parameters for deleteIdentityProfileV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiDeleteIdentityProfileV1Request */ export interface IdentityProfilesApiDeleteIdentityProfileV1Request { /** * Identity profile ID. * @type {string} * @memberof IdentityProfilesApiDeleteIdentityProfileV1 */ readonly identityProfileId: string } /** * Request parameters for deleteIdentityProfilesV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiDeleteIdentityProfilesV1Request */ export interface IdentityProfilesApiDeleteIdentityProfilesV1Request { /** * Identity Profile bulk delete request body. * @type {Array} * @memberof IdentityProfilesApiDeleteIdentityProfilesV1 */ readonly requestBody: Array } /** * Request parameters for exportIdentityProfilesV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiExportIdentityProfilesV1Request */ export interface IdentityProfilesApiExportIdentityProfilesV1Request { /** * 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 IdentityProfilesApiExportIdentityProfilesV1 */ 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 IdentityProfilesApiExportIdentityProfilesV1 */ 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 IdentityProfilesApiExportIdentityProfilesV1 */ readonly count?: boolean /** * 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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* * @type {string} * @memberof IdentityProfilesApiExportIdentityProfilesV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** * @type {string} * @memberof IdentityProfilesApiExportIdentityProfilesV1 */ readonly sorters?: string } /** * Request parameters for generateIdentityPreviewV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiGenerateIdentityPreviewV1Request */ export interface IdentityProfilesApiGenerateIdentityPreviewV1Request { /** * Identity Preview request body. * @type {IdentityPreviewRequest} * @memberof IdentityProfilesApiGenerateIdentityPreviewV1 */ readonly identityPreviewRequest: IdentityPreviewRequest } /** * Request parameters for getDefaultIdentityAttributeConfigV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiGetDefaultIdentityAttributeConfigV1Request */ export interface IdentityProfilesApiGetDefaultIdentityAttributeConfigV1Request { /** * The Identity Profile ID. * @type {string} * @memberof IdentityProfilesApiGetDefaultIdentityAttributeConfigV1 */ readonly identityProfileId: string } /** * Request parameters for getIdentityProfileV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiGetIdentityProfileV1Request */ export interface IdentityProfilesApiGetIdentityProfileV1Request { /** * Identity profile ID. * @type {string} * @memberof IdentityProfilesApiGetIdentityProfileV1 */ readonly identityProfileId: string } /** * Request parameters for importIdentityProfilesV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiImportIdentityProfilesV1Request */ export interface IdentityProfilesApiImportIdentityProfilesV1Request { /** * Previously exported Identity Profiles. * @type {Array} * @memberof IdentityProfilesApiImportIdentityProfilesV1 */ readonly identityProfileExportedObject: Array } /** * Request parameters for listIdentityProfilesV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiListIdentityProfilesV1Request */ export interface IdentityProfilesApiListIdentityProfilesV1Request { /** * 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 IdentityProfilesApiListIdentityProfilesV1 */ 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 IdentityProfilesApiListIdentityProfilesV1 */ 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 IdentityProfilesApiListIdentityProfilesV1 */ readonly count?: boolean /** * 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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* * @type {string} * @memberof IdentityProfilesApiListIdentityProfilesV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** * @type {string} * @memberof IdentityProfilesApiListIdentityProfilesV1 */ readonly sorters?: string } /** * Request parameters for syncIdentityProfileV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiSyncIdentityProfileV1Request */ export interface IdentityProfilesApiSyncIdentityProfileV1Request { /** * The Identity Profile ID to be processed * @type {string} * @memberof IdentityProfilesApiSyncIdentityProfileV1 */ readonly identityProfileId: string } /** * Request parameters for updateIdentityProfileV1 operation in IdentityProfilesApi. * @export * @interface IdentityProfilesApiUpdateIdentityProfileV1Request */ export interface IdentityProfilesApiUpdateIdentityProfileV1Request { /** * Identity profile ID. * @type {string} * @memberof IdentityProfilesApiUpdateIdentityProfileV1 */ readonly identityProfileId: string /** * List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @type {Array} * @memberof IdentityProfilesApiUpdateIdentityProfileV1 */ readonly jsonPatchOperation: Array } /** * IdentityProfilesApi - object-oriented interface * @export * @class IdentityProfilesApi * @extends {BaseAPI} */ export class IdentityProfilesApi extends BaseAPI { /** * Creates an identity profile. * @summary Create identity profile * @param {IdentityProfilesApiCreateIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public createIdentityProfileV1(requestParameters: IdentityProfilesApiCreateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).createIdentityProfileV1(requestParameters.identityProfile, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. * @summary Delete identity profile * @param {IdentityProfilesApiDeleteIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public deleteIdentityProfileV1(requestParameters: IdentityProfilesApiDeleteIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).deleteIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete * @summary Delete identity profiles * @param {IdentityProfilesApiDeleteIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public deleteIdentityProfilesV1(requestParameters: IdentityProfilesApiDeleteIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).deleteIdentityProfilesV1(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This exports existing identity profiles in the format specified by the sp-config service. * @summary Export identity profiles * @param {IdentityProfilesApiExportIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public exportIdentityProfilesV1(requestParameters: IdentityProfilesApiExportIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).exportIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. * @summary Generate identity profile preview * @param {IdentityProfilesApiGenerateIdentityPreviewV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public generateIdentityPreviewV1(requestParameters: IdentityProfilesApiGenerateIdentityPreviewV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).generateIdentityPreviewV1(requestParameters.identityPreviewRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This returns the default identity attribute config. * @summary Get default identity attribute config * @param {IdentityProfilesApiGetDefaultIdentityAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public getDefaultIdentityAttributeConfigV1(requestParameters: IdentityProfilesApiGetDefaultIdentityAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).getDefaultIdentityAttributeConfigV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a single identity profile by ID. * @summary Get identity profile * @param {IdentityProfilesApiGetIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public getIdentityProfileV1(requestParameters: IdentityProfilesApiGetIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).getIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This imports previously exported identity profiles. * @summary Import identity profiles * @param {IdentityProfilesApiImportIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public importIdentityProfilesV1(requestParameters: IdentityProfilesApiImportIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).importIdentityProfilesV1(requestParameters.identityProfileExportedObject, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a list of identity profiles, based on the specified query parameters. * @summary List identity profiles * @param {IdentityProfilesApiListIdentityProfilesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public listIdentityProfilesV1(requestParameters: IdentityProfilesApiListIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).listIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. * @summary Process identities under profile * @param {IdentityProfilesApiSyncIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public syncIdentityProfileV1(requestParameters: IdentityProfilesApiSyncIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).syncIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. * @summary Update identity profile * @param {IdentityProfilesApiUpdateIdentityProfileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProfilesApi */ public updateIdentityProfileV1(requestParameters: IdentityProfilesApiUpdateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityProfilesApiFp(this.configuration).updateIdentityProfileV1(requestParameters.identityProfileId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } }