/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Configuration Hub * 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 ApprovalComment */ export interface ApprovalComment { /** * Comment provided either by the approval requester or the approver. * @type {string} * @memberof ApprovalComment */ 'comment': string; /** * The time when this comment was provided. * @type {string} * @memberof ApprovalComment */ 'timestamp': string; /** * Name of the user that provided this comment. * @type {string} * @memberof ApprovalComment */ 'user': string; /** * Id of the user that provided this comment. * @type {string} * @memberof ApprovalComment */ 'id': string; /** * Status transition of the draft. * @type {string} * @memberof ApprovalComment */ 'changedToStatus': ApprovalCommentChangedToStatusEnum; } export const ApprovalCommentChangedToStatusEnum = { PendingApproval: 'PENDING_APPROVAL', Approved: 'APPROVED', Rejected: 'REJECTED' } as const; export type ApprovalCommentChangedToStatusEnum = typeof ApprovalCommentChangedToStatusEnum[keyof typeof ApprovalCommentChangedToStatusEnum]; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * Backup options control what will be included in the backup. * @export * @interface BackupOptions */ export interface BackupOptions { /** * Object type names to be included in a Configuration Hub backup command. * @type {Array} * @memberof BackupOptions */ 'includeTypes'?: Array; /** * Additional options targeting specific objects related to each item in the includeTypes field. * @type {{ [key: string]: ObjectExportImportNames; }} * @memberof BackupOptions */ 'objectOptions'?: { [key: string]: ObjectExportImportNames; }; } export const BackupOptionsIncludeTypesEnum = { 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 BackupOptionsIncludeTypesEnum = typeof BackupOptionsIncludeTypesEnum[keyof typeof BackupOptionsIncludeTypesEnum]; /** * * @export * @interface BackupResponse */ export interface BackupResponse { /** * Unique id assigned to this backup. * @type {string} * @memberof BackupResponse */ 'jobId'?: string; /** * Status of the backup. * @type {string} * @memberof BackupResponse */ 'status'?: BackupResponseStatusEnum; /** * Type of the job, will always be BACKUP for this type of job. * @type {string} * @memberof BackupResponse */ 'type'?: BackupResponseTypeEnum; /** * The name of the tenant performing the upload * @type {string} * @memberof BackupResponse */ 'tenant'?: string; /** * The name of the requester. * @type {string} * @memberof BackupResponse */ 'requesterName'?: string; /** * Whether or not a file was created and stored for this backup. * @type {boolean} * @memberof BackupResponse */ 'fileExists'?: boolean; /** * The time the job was started. * @type {string} * @memberof BackupResponse */ 'created'?: string; /** * The time of the last update to the job. * @type {string} * @memberof BackupResponse */ 'modified'?: string; /** * The time the job was completed. * @type {string} * @memberof BackupResponse */ 'completed'?: string; /** * The name assigned to the upload file in the request body. * @type {string} * @memberof BackupResponse */ 'name'?: string; /** * Whether this backup can be deleted by a regular user. * @type {boolean} * @memberof BackupResponse */ 'userCanDelete'?: boolean; /** * Whether this backup contains all supported object types or only some of them. * @type {boolean} * @memberof BackupResponse */ 'isPartial'?: boolean; /** * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. * @type {string} * @memberof BackupResponse */ 'backupType'?: BackupResponseBackupTypeEnum; /** * * @type {BackupOptions} * @memberof BackupResponse */ 'options'?: BackupOptions | null; /** * Whether the object details of this backup are ready. * @type {string} * @memberof BackupResponse */ 'hydrationStatus'?: BackupResponseHydrationStatusEnum; /** * Number of objects contained in this backup. * @type {number} * @memberof BackupResponse */ 'totalObjectCount'?: number; /** * Whether this backup has been transferred to a customer storage location. * @type {string} * @memberof BackupResponse */ 'cloudStorageStatus'?: BackupResponseCloudStorageStatusEnum; } export const BackupResponseStatusEnum = { NotStarted: 'NOT_STARTED', InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', Cancelled: 'CANCELLED', Failed: 'FAILED' } as const; export type BackupResponseStatusEnum = typeof BackupResponseStatusEnum[keyof typeof BackupResponseStatusEnum]; export const BackupResponseTypeEnum = { Backup: 'BACKUP' } as const; export type BackupResponseTypeEnum = typeof BackupResponseTypeEnum[keyof typeof BackupResponseTypeEnum]; export const BackupResponseBackupTypeEnum = { Uploaded: 'UPLOADED', Automated: 'AUTOMATED', Manual: 'MANUAL' } as const; export type BackupResponseBackupTypeEnum = typeof BackupResponseBackupTypeEnum[keyof typeof BackupResponseBackupTypeEnum]; export const BackupResponseHydrationStatusEnum = { Hydrated: 'HYDRATED', NotHydrated: 'NOT_HYDRATED' } as const; export type BackupResponseHydrationStatusEnum = typeof BackupResponseHydrationStatusEnum[keyof typeof BackupResponseHydrationStatusEnum]; export const BackupResponseCloudStorageStatusEnum = { Synced: 'SYNCED', NotSynced: 'NOT_SYNCED', SyncFailed: 'SYNC_FAILED' } as const; export type BackupResponseCloudStorageStatusEnum = typeof BackupResponseCloudStorageStatusEnum[keyof typeof BackupResponseCloudStorageStatusEnum]; /** * * @export * @interface CreateUploadedConfigurationV1Request */ export interface CreateUploadedConfigurationV1Request { /** * JSON file containing the objects to be imported. * @type {File} * @memberof CreateUploadedConfigurationV1Request */ 'data': File; /** * Name that will be assigned to the uploaded configuration file. * @type {string} * @memberof CreateUploadedConfigurationV1Request */ 'name': string; } /** * * @export * @interface DeployRequest */ export interface DeployRequest { /** * The id of the draft to be used by this deploy. * @type {string} * @memberof DeployRequest */ 'draftId': string; } /** * * @export * @interface DeployResponse */ export interface DeployResponse { /** * Unique id assigned to this job. * @type {string} * @memberof DeployResponse */ 'jobId'?: string; /** * Status of the job. * @type {string} * @memberof DeployResponse */ 'status'?: DeployResponseStatusEnum; /** * Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. * @type {string} * @memberof DeployResponse */ 'type'?: DeployResponseTypeEnum; /** * Message providing information about the outcome of the deploy process. * @type {string} * @memberof DeployResponse */ 'message'?: string; /** * The name of the user that initiated the deploy process. * @type {string} * @memberof DeployResponse */ 'requesterName'?: string; /** * Whether or not a results file was created and stored for this deploy. * @type {boolean} * @memberof DeployResponse */ 'fileExists'?: boolean; /** * The time the job was started. * @type {string} * @memberof DeployResponse */ 'created'?: string; /** * The time of the last update to the job. * @type {string} * @memberof DeployResponse */ 'modified'?: string; /** * The time the job was completed. * @type {string} * @memberof DeployResponse */ 'completed'?: string; /** * The id of the draft that was used for this deploy. * @type {string} * @memberof DeployResponse */ 'draftId'?: string; /** * The name of the draft that was used for this deploy. * @type {string} * @memberof DeployResponse */ 'draftName'?: string; /** * Whether this deploy results file has been transferred to a customer storage location. * @type {string} * @memberof DeployResponse */ 'cloudStorageStatus'?: DeployResponseCloudStorageStatusEnum; } export const DeployResponseStatusEnum = { NotStarted: 'NOT_STARTED', InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', Cancelled: 'CANCELLED', Failed: 'FAILED' } as const; export type DeployResponseStatusEnum = typeof DeployResponseStatusEnum[keyof typeof DeployResponseStatusEnum]; export const DeployResponseTypeEnum = { ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' } as const; export type DeployResponseTypeEnum = typeof DeployResponseTypeEnum[keyof typeof DeployResponseTypeEnum]; export const DeployResponseCloudStorageStatusEnum = { Synced: 'SYNCED', NotSynced: 'NOT_SYNCED', SyncFailed: 'SYNC_FAILED' } as const; export type DeployResponseCloudStorageStatusEnum = typeof DeployResponseCloudStorageStatusEnum[keyof typeof DeployResponseCloudStorageStatusEnum]; /** * * @export * @interface DraftResponse */ export interface DraftResponse { /** * Unique id assigned to this job. * @type {string} * @memberof DraftResponse */ 'jobId'?: string; /** * Status of the job. * @type {string} * @memberof DraftResponse */ 'status'?: DraftResponseStatusEnum; /** * Type of the job, will always be CREATE_DRAFT for this type of job. * @type {string} * @memberof DraftResponse */ 'type'?: DraftResponseTypeEnum; /** * Message providing information about the outcome of the draft process. * @type {string} * @memberof DraftResponse */ 'message'?: string; /** * The name of user that that initiated the draft process. * @type {string} * @memberof DraftResponse */ 'requesterName'?: string; /** * Whether or not a file was generated for this draft. * @type {boolean} * @memberof DraftResponse */ 'fileExists'?: boolean; /** * The time the job was started. * @type {string} * @memberof DraftResponse */ 'created'?: string; /** * The time of the last update to the job. * @type {string} * @memberof DraftResponse */ 'modified'?: string; /** * The time the job was completed. * @type {string} * @memberof DraftResponse */ 'completed'?: string; /** * Name of the draft. * @type {string} * @memberof DraftResponse */ 'name'?: string; /** * Tenant owner of the backup from which the draft was generated. * @type {string} * @memberof DraftResponse */ 'sourceTenant'?: string; /** * Id of the backup from which the draft was generated. * @type {string} * @memberof DraftResponse */ 'sourceBackupId'?: string; /** * Name of the backup from which the draft was generated. * @type {string} * @memberof DraftResponse */ 'sourceBackupName'?: string; /** * Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. * @type {string} * @memberof DraftResponse */ 'mode'?: DraftResponseModeEnum; /** * Approval status of the draft used to determine whether or not the draft can be deployed. * @type {string} * @memberof DraftResponse */ 'approvalStatus'?: DraftResponseApprovalStatusEnum; /** * List of comments that have been exchanged between an approval requester and an approver. * @type {Array} * @memberof DraftResponse */ 'approvalComment'?: Array; } export const DraftResponseStatusEnum = { NotStarted: 'NOT_STARTED', InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', Cancelled: 'CANCELLED', Failed: 'FAILED' } as const; export type DraftResponseStatusEnum = typeof DraftResponseStatusEnum[keyof typeof DraftResponseStatusEnum]; export const DraftResponseTypeEnum = { CreateDraft: 'CREATE_DRAFT' } as const; export type DraftResponseTypeEnum = typeof DraftResponseTypeEnum[keyof typeof DraftResponseTypeEnum]; export const DraftResponseModeEnum = { Restore: 'RESTORE', Promote: 'PROMOTE', Upload: 'UPLOAD' } as const; export type DraftResponseModeEnum = typeof DraftResponseModeEnum[keyof typeof DraftResponseModeEnum]; export const DraftResponseApprovalStatusEnum = { Default: 'DEFAULT', PendingApproval: 'PENDING_APPROVAL', Approved: 'APPROVED', Denied: 'DENIED' } as const; export type DraftResponseApprovalStatusEnum = typeof DraftResponseApprovalStatusEnum[keyof typeof DraftResponseApprovalStatusEnum]; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetObjectMappingsV1401Response */ export interface GetObjectMappingsV1401Response { /** * A message describing the error * @type {any} * @memberof GetObjectMappingsV1401Response */ 'error'?: any; } /** * * @export * @interface GetObjectMappingsV1429Response */ export interface GetObjectMappingsV1429Response { /** * A message describing the error * @type {any} * @memberof GetObjectMappingsV1429Response */ 'message'?: any; } /** * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatch */ export interface JsonPatch { /** * Operations to be applied * @type {Array} * @memberof JsonPatch */ 'operations'?: Array; } /** * 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 ListDeploysV1200Response */ export interface ListDeploysV1200Response { /** * list of deployments * @type {Array} * @memberof ListDeploysV1200Response */ 'items'?: 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 ObjectExportImportNames */ export interface ObjectExportImportNames { /** * Object names to be included in a backup. * @type {Array} * @memberof ObjectExportImportNames */ 'includedNames'?: Array; } /** * * @export * @interface ObjectMappingBulkCreateRequest */ export interface ObjectMappingBulkCreateRequest { /** * * @type {Array} * @memberof ObjectMappingBulkCreateRequest */ 'newObjectsMappings': Array; } /** * * @export * @interface ObjectMappingBulkCreateResponse */ export interface ObjectMappingBulkCreateResponse { /** * * @type {Array} * @memberof ObjectMappingBulkCreateResponse */ 'addedObjects'?: Array; } /** * * @export * @interface ObjectMappingBulkPatchRequest */ export interface ObjectMappingBulkPatchRequest { /** * Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. * @type {{ [key: string]: Array; }} * @memberof ObjectMappingBulkPatchRequest */ 'patches': { [key: string]: Array; }; } /** * * @export * @interface ObjectMappingBulkPatchResponse */ export interface ObjectMappingBulkPatchResponse { /** * * @type {Array} * @memberof ObjectMappingBulkPatchResponse */ 'patchedObjects'?: Array; } /** * * @export * @interface ObjectMappingRequest */ export interface ObjectMappingRequest { /** * Type of the object the mapping value applies to, must be one from enum * @type {string} * @memberof ObjectMappingRequest */ 'objectType': ObjectMappingRequestObjectTypeEnum; /** * JSONPath expression denoting the path within the object where the mapping value should be applied * @type {string} * @memberof ObjectMappingRequest */ 'jsonPath': string; /** * Original value at the jsonPath location within the object * @type {string} * @memberof ObjectMappingRequest */ 'sourceValue': string; /** * Value to be assigned at the jsonPath location within the object * @type {string} * @memberof ObjectMappingRequest */ 'targetValue': string; /** * Whether or not this object mapping is enabled * @type {boolean} * @memberof ObjectMappingRequest */ 'enabled'?: boolean; } export const ObjectMappingRequestObjectTypeEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', Entitlement: 'ENTITLEMENT', FormDefinition: 'FORM_DEFINITION', GovernanceGroup: 'GOVERNANCE_GROUP', Identity: 'IDENTITY', 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 ObjectMappingRequestObjectTypeEnum = typeof ObjectMappingRequestObjectTypeEnum[keyof typeof ObjectMappingRequestObjectTypeEnum]; /** * * @export * @interface ObjectMappingResponse */ export interface ObjectMappingResponse { /** * Id of the object mapping * @type {string} * @memberof ObjectMappingResponse */ 'objectMappingId'?: string; /** * Type of the object the mapping value applies to * @type {string} * @memberof ObjectMappingResponse */ 'objectType'?: ObjectMappingResponseObjectTypeEnum; /** * JSONPath expression denoting the path within the object where the mapping value should be applied * @type {string} * @memberof ObjectMappingResponse */ 'jsonPath'?: string; /** * Original value at the jsonPath location within the object * @type {string} * @memberof ObjectMappingResponse */ 'sourceValue'?: string; /** * Value to be assigned at the jsonPath location within the object * @type {string} * @memberof ObjectMappingResponse */ 'targetValue'?: string; /** * Whether or not this object mapping is enabled * @type {boolean} * @memberof ObjectMappingResponse */ 'enabled'?: boolean; /** * Object mapping creation timestamp * @type {string} * @memberof ObjectMappingResponse */ 'created'?: string; /** * Object mapping latest update timestamp * @type {string} * @memberof ObjectMappingResponse */ 'modified'?: string; } export const ObjectMappingResponseObjectTypeEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', Entitlement: 'ENTITLEMENT', FormDefinition: 'FORM_DEFINITION', GovernanceGroup: 'GOVERNANCE_GROUP', Identity: 'IDENTITY', 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 ObjectMappingResponseObjectTypeEnum = typeof ObjectMappingResponseObjectTypeEnum[keyof typeof ObjectMappingResponseObjectTypeEnum]; /** * * @export * @interface ScheduledActionPayload */ export interface ScheduledActionPayload { /** * Type of the scheduled job. * @type {string} * @memberof ScheduledActionPayload */ 'jobType': ScheduledActionPayloadJobTypeEnum; /** * The time when this scheduled action should start. Optional. * @type {string} * @memberof ScheduledActionPayload */ 'startTime'?: string; /** * Cron expression defining the schedule for this action. Optional for repeated events. * @type {string} * @memberof ScheduledActionPayload */ 'cronString'?: string; /** * Time zone ID for interpreting the cron expression. Optional, will default to current time zone. * @type {string} * @memberof ScheduledActionPayload */ 'timeZoneId'?: string; /** * * @type {ScheduledActionPayloadContent} * @memberof ScheduledActionPayload */ 'content': ScheduledActionPayloadContent; } export const ScheduledActionPayloadJobTypeEnum = { Backup: 'BACKUP', CreateDraft: 'CREATE_DRAFT', ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' } as const; export type ScheduledActionPayloadJobTypeEnum = typeof ScheduledActionPayloadJobTypeEnum[keyof typeof ScheduledActionPayloadJobTypeEnum]; /** * * @export * @interface ScheduledActionPayloadContent */ export interface ScheduledActionPayloadContent { /** * Name of the scheduled action (maximum 50 characters). * @type {string} * @memberof ScheduledActionPayloadContent */ 'name': string; /** * * @type {ScheduledActionPayloadContentBackupOptions} * @memberof ScheduledActionPayloadContent */ 'backupOptions'?: ScheduledActionPayloadContentBackupOptions; /** * ID of the source backup. Required for CREATE_DRAFT jobs. * @type {string} * @memberof ScheduledActionPayloadContent */ 'sourceBackupId'?: string; /** * Source tenant identifier. Required for CREATE_DRAFT jobs. * @type {string} * @memberof ScheduledActionPayloadContent */ 'sourceTenant'?: string; /** * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. * @type {string} * @memberof ScheduledActionPayloadContent */ 'draftId'?: string; } /** * Options for BACKUP type jobs. Required for BACKUP jobs. * @export * @interface ScheduledActionPayloadContentBackupOptions */ export interface ScheduledActionPayloadContentBackupOptions { /** * Object types that are to be included in the backup. * @type {Array} * @memberof ScheduledActionPayloadContentBackupOptions */ 'includeTypes'?: Array; /** * Map of objectType string to the options to be passed to the target service for that objectType. * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValue; }} * @memberof ScheduledActionPayloadContentBackupOptions */ 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValue; }; } /** * * @export * @interface ScheduledActionResponse */ export interface ScheduledActionResponse { /** * Unique identifier for this scheduled action. * @type {string} * @memberof ScheduledActionResponse */ 'id'?: string; /** * The time when this scheduled action was created. * @type {string} * @memberof ScheduledActionResponse */ 'created'?: string; /** * Type of the scheduled job. * @type {string} * @memberof ScheduledActionResponse */ 'jobType'?: ScheduledActionResponseJobTypeEnum; /** * * @type {ScheduledActionResponseContent} * @memberof ScheduledActionResponse */ 'content'?: ScheduledActionResponseContent; /** * The time when this scheduled action should start. * @type {string} * @memberof ScheduledActionResponse */ 'startTime'?: string; /** * Cron expression defining the schedule for this action. * @type {string} * @memberof ScheduledActionResponse */ 'cronString'?: string; /** * Time zone ID for interpreting the cron expression. * @type {string} * @memberof ScheduledActionResponse */ 'timeZoneId'?: string; } export const ScheduledActionResponseJobTypeEnum = { Backup: 'BACKUP', CreateDraft: 'CREATE_DRAFT', ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' } as const; export type ScheduledActionResponseJobTypeEnum = typeof ScheduledActionResponseJobTypeEnum[keyof typeof ScheduledActionResponseJobTypeEnum]; /** * Content details for the scheduled action. * @export * @interface ScheduledActionResponseContent */ export interface ScheduledActionResponseContent { /** * Name of the scheduled action (maximum 50 characters). * @type {string} * @memberof ScheduledActionResponseContent */ 'name'?: string; /** * * @type {ScheduledActionResponseContentBackupOptions} * @memberof ScheduledActionResponseContent */ 'backupOptions'?: ScheduledActionResponseContentBackupOptions; /** * ID of the source backup. Required for CREATE_DRAFT jobs only. * @type {string} * @memberof ScheduledActionResponseContent */ 'sourceBackupId'?: string; /** * Source tenant identifier. Required for CREATE_DRAFT jobs only. * @type {string} * @memberof ScheduledActionResponseContent */ 'sourceTenant'?: string; /** * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. * @type {string} * @memberof ScheduledActionResponseContent */ 'draftId'?: string; } /** * Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only. * @export * @interface ScheduledActionResponseContentBackupOptions */ export interface ScheduledActionResponseContentBackupOptions { /** * Object types that are to be included in the backup. * @type {Array} * @memberof ScheduledActionResponseContentBackupOptions */ 'includeTypes'?: Array; /** * Map of objectType string to the options to be passed to the target service for that objectType. * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValue; }} * @memberof ScheduledActionResponseContentBackupOptions */ 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValue; }; } /** * * @export * @interface ScheduledActionResponseContentBackupOptionsObjectOptionsValue */ export interface ScheduledActionResponseContentBackupOptionsObjectOptionsValue { /** * Set of names to be included. * @type {Array} * @memberof ScheduledActionResponseContentBackupOptionsObjectOptionsValue */ 'includedNames'?: Array; } /** * ConfigurationHubApi - axios parameter creator * @export */ export const ConfigurationHubApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This API performs a deploy based on an existing daft. * @summary Create a deploy * @param {DeployRequest} deployRequest The deploy request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createDeployV1: async (deployRequest: DeployRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'deployRequest' is not null or undefined assertParamExists('createDeployV1', 'deployRequest', deployRequest) const localVarPath = `/configuration-hub/v1/deploys`; // 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(deployRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Creates an object mapping * @param {string} sourceOrg The name of the source org. * @param {ObjectMappingRequest} objectMappingRequest The object mapping request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createObjectMappingV1: async (sourceOrg: string, objectMappingRequest: ObjectMappingRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceOrg' is not null or undefined assertParamExists('createObjectMappingV1', 'sourceOrg', sourceOrg) // verify required parameter 'objectMappingRequest' is not null or undefined assertParamExists('createObjectMappingV1', 'objectMappingRequest', objectMappingRequest) const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}` .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); // 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(objectMappingRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk creates object mappings * @param {string} sourceOrg The name of the source org. * @param {ObjectMappingBulkCreateRequest} objectMappingBulkCreateRequest The bulk create object mapping request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createObjectMappingsV1: async (sourceOrg: string, objectMappingBulkCreateRequest: ObjectMappingBulkCreateRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceOrg' is not null or undefined assertParamExists('createObjectMappingsV1', 'sourceOrg', sourceOrg) // verify required parameter 'objectMappingBulkCreateRequest' is not null or undefined assertParamExists('createObjectMappingsV1', 'objectMappingBulkCreateRequest', objectMappingBulkCreateRequest) const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}/bulk-create` .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); // 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(objectMappingBulkCreateRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API creates a new scheduled action for the current tenant. * @summary Create scheduled action * @param {ScheduledActionPayload} scheduledActionPayload The scheduled action creation request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createScheduledActionV1: async (scheduledActionPayload: ScheduledActionPayload, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'scheduledActionPayload' is not null or undefined assertParamExists('createScheduledActionV1', 'scheduledActionPayload', scheduledActionPayload) const localVarPath = `/configuration-hub/v1/scheduled-actions`; // 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(scheduledActionPayload, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. * @summary Upload a configuration * @param {File} data JSON file containing the objects to be imported. * @param {string} name Name that will be assigned to the uploaded configuration file. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUploadedConfigurationV1: async (data: File, name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'data' is not null or undefined assertParamExists('createUploadedConfigurationV1', 'data', data) // verify required parameter 'name' is not null or undefined assertParamExists('createUploadedConfigurationV1', 'name', name) const localVarPath = `/configuration-hub/v1/backups/uploads`; // 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; const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); if (data !== undefined) { localVarFormParams.append('data', data as any); } if (name !== undefined) { localVarFormParams.append('name', name as any); } localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = localVarFormParams; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. * @summary Delete a backup * @param {string} id The id of the backup to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteBackupV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteBackupV1', 'id', id) const localVarPath = `/configuration-hub/v1/backups/{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: '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 API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. * @summary Delete a draft * @param {string} id The id of the draft to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteDraftV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteDraftV1', 'id', id) const localVarPath = `/configuration-hub/v1/drafts/{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: '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 an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Deletes an object mapping * @param {string} sourceOrg The name of the source org. * @param {string} objectMappingId The id of the object mapping to be deleted. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteObjectMappingV1: async (sourceOrg: string, objectMappingId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceOrg' is not null or undefined assertParamExists('deleteObjectMappingV1', 'sourceOrg', sourceOrg) // verify required parameter 'objectMappingId' is not null or undefined assertParamExists('deleteObjectMappingV1', 'objectMappingId', objectMappingId) const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}/{objectMappingId}` .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))) .replace(`{${"objectMappingId"}}`, encodeURIComponent(String(objectMappingId))); // 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 API deletes an existing scheduled action. * @summary Delete scheduled action * @param {string} id The ID of the scheduled action. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteScheduledActionV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteScheduledActionV1', 'id', id) const localVarPath = `/configuration-hub/v1/scheduled-actions/{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: '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 API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. * @summary Delete an uploaded configuration * @param {string} id The id of the uploaded configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUploadedConfigurationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteUploadedConfigurationV1', 'id', id) const localVarPath = `/configuration-hub/v1/backups/uploads/{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: '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 API gets an existing deploy for the current tenant. * @summary Get a deploy * @param {string} id The id of the deploy. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDeployV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getDeployV1', 'id', id) const localVarPath = `/configuration-hub/v1/deploys/{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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read * @summary Gets list of object mappings * @param {string} sourceOrg The name of the source org. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getObjectMappingsV1: async (sourceOrg: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceOrg' is not null or undefined assertParamExists('getObjectMappingsV1', 'sourceOrg', sourceOrg) const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}` .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); // 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 API gets an existing uploaded configuration for the current tenant. * @summary Get an uploaded configuration * @param {string} id The id of the uploaded configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUploadedConfigurationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getUploadedConfigurationV1', 'id', id) const localVarPath = `/configuration-hub/v1/backups/uploads/{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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API gets a list of existing backups for the current tenant. * @summary List backups * @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: **status**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listBackupsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/configuration-hub/v1/backups`; // 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; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API gets a list of deploys for the current tenant. * @summary List deploys * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listDeploysV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/configuration-hub/v1/deploys`; // 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 API gets a list of existing drafts for the current tenant. * @summary List drafts * @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: **status**: *eq* **approvalStatus**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listDraftsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/configuration-hub/v1/drafts`; // 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; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API gets a list of existing scheduled actions for the current tenant. * @summary List scheduled actions * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listScheduledActionsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/configuration-hub/v1/scheduled-actions`; // 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 API gets a list of existing uploaded configurations for the current tenant. * @summary List uploaded configurations * @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: **status**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUploadedConfigurationsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/configuration-hub/v1/backups/uploads`; // 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; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk updates object mappings * @param {string} sourceOrg The name of the source org. * @param {ObjectMappingBulkPatchRequest} objectMappingBulkPatchRequest The object mapping request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateObjectMappingsV1: async (sourceOrg: string, objectMappingBulkPatchRequest: ObjectMappingBulkPatchRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceOrg' is not null or undefined assertParamExists('updateObjectMappingsV1', 'sourceOrg', sourceOrg) // verify required parameter 'objectMappingBulkPatchRequest' is not null or undefined assertParamExists('updateObjectMappingsV1', 'objectMappingBulkPatchRequest', objectMappingBulkPatchRequest) const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}/bulk-patch` .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); // 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(objectMappingBulkPatchRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API updates an existing scheduled action using JSON Patch format. * @summary Update scheduled action * @param {string} id The ID of the scheduled action. * @param {JsonPatch} jsonPatch The JSON Patch document containing the changes to apply to the scheduled action. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateScheduledActionV1: async (id: string, jsonPatch: JsonPatch, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('updateScheduledActionV1', 'id', id) // verify required parameter 'jsonPatch' is not null or undefined assertParamExists('updateScheduledActionV1', 'jsonPatch', jsonPatch) const localVarPath = `/configuration-hub/v1/scheduled-actions/{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: '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(jsonPatch, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * ConfigurationHubApi - functional programming interface * @export */ export const ConfigurationHubApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ConfigurationHubApiAxiosParamCreator(configuration) return { /** * This API performs a deploy based on an existing daft. * @summary Create a deploy * @param {DeployRequest} deployRequest The deploy request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createDeployV1(deployRequest: DeployRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createDeployV1(deployRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createDeployV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Creates an object mapping * @param {string} sourceOrg The name of the source org. * @param {ObjectMappingRequest} objectMappingRequest The object mapping request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createObjectMappingV1(sourceOrg: string, objectMappingRequest: ObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappingV1(sourceOrg, objectMappingRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createObjectMappingV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk creates object mappings * @param {string} sourceOrg The name of the source org. * @param {ObjectMappingBulkCreateRequest} objectMappingBulkCreateRequest The bulk create object mapping request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createObjectMappingsV1(sourceOrg: string, objectMappingBulkCreateRequest: ObjectMappingBulkCreateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappingsV1(sourceOrg, objectMappingBulkCreateRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createObjectMappingsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API creates a new scheduled action for the current tenant. * @summary Create scheduled action * @param {ScheduledActionPayload} scheduledActionPayload The scheduled action creation request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createScheduledActionV1(scheduledActionPayload: ScheduledActionPayload, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledActionV1(scheduledActionPayload, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createScheduledActionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. * @summary Upload a configuration * @param {File} data JSON file containing the objects to be imported. * @param {string} name Name that will be assigned to the uploaded configuration file. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createUploadedConfigurationV1(data: File, name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createUploadedConfigurationV1(data, name, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createUploadedConfigurationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. * @summary Delete a backup * @param {string} id The id of the backup to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteBackupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBackupV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.deleteBackupV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. * @summary Delete a draft * @param {string} id The id of the draft to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteDraftV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDraftV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.deleteDraftV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Deletes an object mapping * @param {string} sourceOrg The name of the source org. * @param {string} objectMappingId The id of the object mapping to be deleted. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteObjectMappingV1(sourceOrg: string, objectMappingId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectMappingV1(sourceOrg, objectMappingId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.deleteObjectMappingV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API deletes an existing scheduled action. * @summary Delete scheduled action * @param {string} id The ID of the scheduled action. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteScheduledActionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledActionV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.deleteScheduledActionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. * @summary Delete an uploaded configuration * @param {string} id The id of the uploaded configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteUploadedConfigurationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUploadedConfigurationV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.deleteUploadedConfigurationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets an existing deploy for the current tenant. * @summary Get a deploy * @param {string} id The id of the deploy. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getDeployV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDeployV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.getDeployV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read * @summary Gets list of object mappings * @param {string} sourceOrg The name of the source org. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getObjectMappingsV1(sourceOrg: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMappingsV1(sourceOrg, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.getObjectMappingsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets an existing uploaded configuration for the current tenant. * @summary Get an uploaded configuration * @param {string} id The id of the uploaded configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getUploadedConfigurationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUploadedConfigurationV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.getUploadedConfigurationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets a list of existing backups for the current tenant. * @summary List backups * @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: **status**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listBackupsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listBackupsV1(filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.listBackupsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets a list of deploys for the current tenant. * @summary List deploys * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listDeploysV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listDeploysV1(axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.listDeploysV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets a list of existing drafts for the current tenant. * @summary List drafts * @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: **status**: *eq* **approvalStatus**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listDraftsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listDraftsV1(filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.listDraftsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets a list of existing scheduled actions for the current tenant. * @summary List scheduled actions * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listScheduledActionsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledActionsV1(axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.listScheduledActionsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets a list of existing uploaded configurations for the current tenant. * @summary List uploaded configurations * @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: **status**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listUploadedConfigurationsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listUploadedConfigurationsV1(filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.listUploadedConfigurationsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk updates object mappings * @param {string} sourceOrg The name of the source org. * @param {ObjectMappingBulkPatchRequest} objectMappingBulkPatchRequest The object mapping request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateObjectMappingsV1(sourceOrg: string, objectMappingBulkPatchRequest: ObjectMappingBulkPatchRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateObjectMappingsV1(sourceOrg, objectMappingBulkPatchRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.updateObjectMappingsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API updates an existing scheduled action using JSON Patch format. * @summary Update scheduled action * @param {string} id The ID of the scheduled action. * @param {JsonPatch} jsonPatch The JSON Patch document containing the changes to apply to the scheduled action. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateScheduledActionV1(id: string, jsonPatch: JsonPatch, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledActionV1(id, jsonPatch, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.updateScheduledActionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * ConfigurationHubApi - factory interface * @export */ export const ConfigurationHubApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ConfigurationHubApiFp(configuration) return { /** * This API performs a deploy based on an existing daft. * @summary Create a deploy * @param {ConfigurationHubApiCreateDeployV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createDeployV1(requestParameters: ConfigurationHubApiCreateDeployV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createDeployV1(requestParameters.deployRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Creates an object mapping * @param {ConfigurationHubApiCreateObjectMappingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createObjectMappingV1(requestParameters: ConfigurationHubApiCreateObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectMappingRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk creates object mappings * @param {ConfigurationHubApiCreateObjectMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createObjectMappingsV1(requestParameters: ConfigurationHubApiCreateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API creates a new scheduled action for the current tenant. * @summary Create scheduled action * @param {ConfigurationHubApiCreateScheduledActionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createScheduledActionV1(requestParameters: ConfigurationHubApiCreateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createScheduledActionV1(requestParameters.scheduledActionPayload, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. * @summary Upload a configuration * @param {ConfigurationHubApiCreateUploadedConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUploadedConfigurationV1(requestParameters: ConfigurationHubApiCreateUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createUploadedConfigurationV1(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. * @summary Delete a backup * @param {ConfigurationHubApiDeleteBackupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteBackupV1(requestParameters: ConfigurationHubApiDeleteBackupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteBackupV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. * @summary Delete a draft * @param {ConfigurationHubApiDeleteDraftV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteDraftV1(requestParameters: ConfigurationHubApiDeleteDraftV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteDraftV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Deletes an object mapping * @param {ConfigurationHubApiDeleteObjectMappingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteObjectMappingV1(requestParameters: ConfigurationHubApiDeleteObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API deletes an existing scheduled action. * @summary Delete scheduled action * @param {ConfigurationHubApiDeleteScheduledActionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteScheduledActionV1(requestParameters: ConfigurationHubApiDeleteScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteScheduledActionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. * @summary Delete an uploaded configuration * @param {ConfigurationHubApiDeleteUploadedConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUploadedConfigurationV1(requestParameters: ConfigurationHubApiDeleteUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets an existing deploy for the current tenant. * @summary Get a deploy * @param {ConfigurationHubApiGetDeployV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDeployV1(requestParameters: ConfigurationHubApiGetDeployV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getDeployV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read * @summary Gets list of object mappings * @param {ConfigurationHubApiGetObjectMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getObjectMappingsV1(requestParameters: ConfigurationHubApiGetObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getObjectMappingsV1(requestParameters.sourceOrg, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets an existing uploaded configuration for the current tenant. * @summary Get an uploaded configuration * @param {ConfigurationHubApiGetUploadedConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUploadedConfigurationV1(requestParameters: ConfigurationHubApiGetUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets a list of existing backups for the current tenant. * @summary List backups * @param {ConfigurationHubApiListBackupsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listBackupsV1(requestParameters: ConfigurationHubApiListBackupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listBackupsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets a list of deploys for the current tenant. * @summary List deploys * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listDeploysV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.listDeploysV1(axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets a list of existing drafts for the current tenant. * @summary List drafts * @param {ConfigurationHubApiListDraftsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listDraftsV1(requestParameters: ConfigurationHubApiListDraftsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listDraftsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets a list of existing scheduled actions for the current tenant. * @summary List scheduled actions * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listScheduledActionsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listScheduledActionsV1(axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets a list of existing uploaded configurations for the current tenant. * @summary List uploaded configurations * @param {ConfigurationHubApiListUploadedConfigurationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUploadedConfigurationsV1(requestParameters: ConfigurationHubApiListUploadedConfigurationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listUploadedConfigurationsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk updates object mappings * @param {ConfigurationHubApiUpdateObjectMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateObjectMappingsV1(requestParameters: ConfigurationHubApiUpdateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API updates an existing scheduled action using JSON Patch format. * @summary Update scheduled action * @param {ConfigurationHubApiUpdateScheduledActionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateScheduledActionV1(requestParameters: ConfigurationHubApiUpdateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateScheduledActionV1(requestParameters.id, requestParameters.jsonPatch, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createDeployV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiCreateDeployV1Request */ export interface ConfigurationHubApiCreateDeployV1Request { /** * The deploy request body. * @type {DeployRequest} * @memberof ConfigurationHubApiCreateDeployV1 */ readonly deployRequest: DeployRequest } /** * Request parameters for createObjectMappingV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiCreateObjectMappingV1Request */ export interface ConfigurationHubApiCreateObjectMappingV1Request { /** * The name of the source org. * @type {string} * @memberof ConfigurationHubApiCreateObjectMappingV1 */ readonly sourceOrg: string /** * The object mapping request body. * @type {ObjectMappingRequest} * @memberof ConfigurationHubApiCreateObjectMappingV1 */ readonly objectMappingRequest: ObjectMappingRequest } /** * Request parameters for createObjectMappingsV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiCreateObjectMappingsV1Request */ export interface ConfigurationHubApiCreateObjectMappingsV1Request { /** * The name of the source org. * @type {string} * @memberof ConfigurationHubApiCreateObjectMappingsV1 */ readonly sourceOrg: string /** * The bulk create object mapping request body. * @type {ObjectMappingBulkCreateRequest} * @memberof ConfigurationHubApiCreateObjectMappingsV1 */ readonly objectMappingBulkCreateRequest: ObjectMappingBulkCreateRequest } /** * Request parameters for createScheduledActionV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiCreateScheduledActionV1Request */ export interface ConfigurationHubApiCreateScheduledActionV1Request { /** * The scheduled action creation request body. * @type {ScheduledActionPayload} * @memberof ConfigurationHubApiCreateScheduledActionV1 */ readonly scheduledActionPayload: ScheduledActionPayload } /** * Request parameters for createUploadedConfigurationV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiCreateUploadedConfigurationV1Request */ export interface ConfigurationHubApiCreateUploadedConfigurationV1Request { /** * JSON file containing the objects to be imported. * @type {File} * @memberof ConfigurationHubApiCreateUploadedConfigurationV1 */ readonly data: File /** * Name that will be assigned to the uploaded configuration file. * @type {string} * @memberof ConfigurationHubApiCreateUploadedConfigurationV1 */ readonly name: string } /** * Request parameters for deleteBackupV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiDeleteBackupV1Request */ export interface ConfigurationHubApiDeleteBackupV1Request { /** * The id of the backup to delete. * @type {string} * @memberof ConfigurationHubApiDeleteBackupV1 */ readonly id: string } /** * Request parameters for deleteDraftV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiDeleteDraftV1Request */ export interface ConfigurationHubApiDeleteDraftV1Request { /** * The id of the draft to delete. * @type {string} * @memberof ConfigurationHubApiDeleteDraftV1 */ readonly id: string } /** * Request parameters for deleteObjectMappingV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiDeleteObjectMappingV1Request */ export interface ConfigurationHubApiDeleteObjectMappingV1Request { /** * The name of the source org. * @type {string} * @memberof ConfigurationHubApiDeleteObjectMappingV1 */ readonly sourceOrg: string /** * The id of the object mapping to be deleted. * @type {string} * @memberof ConfigurationHubApiDeleteObjectMappingV1 */ readonly objectMappingId: string } /** * Request parameters for deleteScheduledActionV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiDeleteScheduledActionV1Request */ export interface ConfigurationHubApiDeleteScheduledActionV1Request { /** * The ID of the scheduled action. * @type {string} * @memberof ConfigurationHubApiDeleteScheduledActionV1 */ readonly id: string } /** * Request parameters for deleteUploadedConfigurationV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiDeleteUploadedConfigurationV1Request */ export interface ConfigurationHubApiDeleteUploadedConfigurationV1Request { /** * The id of the uploaded configuration. * @type {string} * @memberof ConfigurationHubApiDeleteUploadedConfigurationV1 */ readonly id: string } /** * Request parameters for getDeployV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiGetDeployV1Request */ export interface ConfigurationHubApiGetDeployV1Request { /** * The id of the deploy. * @type {string} * @memberof ConfigurationHubApiGetDeployV1 */ readonly id: string } /** * Request parameters for getObjectMappingsV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiGetObjectMappingsV1Request */ export interface ConfigurationHubApiGetObjectMappingsV1Request { /** * The name of the source org. * @type {string} * @memberof ConfigurationHubApiGetObjectMappingsV1 */ readonly sourceOrg: string } /** * Request parameters for getUploadedConfigurationV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiGetUploadedConfigurationV1Request */ export interface ConfigurationHubApiGetUploadedConfigurationV1Request { /** * The id of the uploaded configuration. * @type {string} * @memberof ConfigurationHubApiGetUploadedConfigurationV1 */ readonly id: string } /** * Request parameters for listBackupsV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiListBackupsV1Request */ export interface ConfigurationHubApiListBackupsV1Request { /** * 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: **status**: *eq* * @type {string} * @memberof ConfigurationHubApiListBackupsV1 */ readonly filters?: string } /** * Request parameters for listDraftsV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiListDraftsV1Request */ export interface ConfigurationHubApiListDraftsV1Request { /** * 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: **status**: *eq* **approvalStatus**: *eq* * @type {string} * @memberof ConfigurationHubApiListDraftsV1 */ readonly filters?: string } /** * Request parameters for listUploadedConfigurationsV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiListUploadedConfigurationsV1Request */ export interface ConfigurationHubApiListUploadedConfigurationsV1Request { /** * 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: **status**: *eq* * @type {string} * @memberof ConfigurationHubApiListUploadedConfigurationsV1 */ readonly filters?: string } /** * Request parameters for updateObjectMappingsV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiUpdateObjectMappingsV1Request */ export interface ConfigurationHubApiUpdateObjectMappingsV1Request { /** * The name of the source org. * @type {string} * @memberof ConfigurationHubApiUpdateObjectMappingsV1 */ readonly sourceOrg: string /** * The object mapping request body. * @type {ObjectMappingBulkPatchRequest} * @memberof ConfigurationHubApiUpdateObjectMappingsV1 */ readonly objectMappingBulkPatchRequest: ObjectMappingBulkPatchRequest } /** * Request parameters for updateScheduledActionV1 operation in ConfigurationHubApi. * @export * @interface ConfigurationHubApiUpdateScheduledActionV1Request */ export interface ConfigurationHubApiUpdateScheduledActionV1Request { /** * The ID of the scheduled action. * @type {string} * @memberof ConfigurationHubApiUpdateScheduledActionV1 */ readonly id: string /** * The JSON Patch document containing the changes to apply to the scheduled action. * @type {JsonPatch} * @memberof ConfigurationHubApiUpdateScheduledActionV1 */ readonly jsonPatch: JsonPatch } /** * ConfigurationHubApi - object-oriented interface * @export * @class ConfigurationHubApi * @extends {BaseAPI} */ export class ConfigurationHubApi extends BaseAPI { /** * This API performs a deploy based on an existing daft. * @summary Create a deploy * @param {ConfigurationHubApiCreateDeployV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public createDeployV1(requestParameters: ConfigurationHubApiCreateDeployV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).createDeployV1(requestParameters.deployRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Creates an object mapping * @param {ConfigurationHubApiCreateObjectMappingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public createObjectMappingV1(requestParameters: ConfigurationHubApiCreateObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).createObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectMappingRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk creates object mappings * @param {ConfigurationHubApiCreateObjectMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public createObjectMappingsV1(requestParameters: ConfigurationHubApiCreateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).createObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API creates a new scheduled action for the current tenant. * @summary Create scheduled action * @param {ConfigurationHubApiCreateScheduledActionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public createScheduledActionV1(requestParameters: ConfigurationHubApiCreateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).createScheduledActionV1(requestParameters.scheduledActionPayload, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. * @summary Upload a configuration * @param {ConfigurationHubApiCreateUploadedConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public createUploadedConfigurationV1(requestParameters: ConfigurationHubApiCreateUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).createUploadedConfigurationV1(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. * @summary Delete a backup * @param {ConfigurationHubApiDeleteBackupV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public deleteBackupV1(requestParameters: ConfigurationHubApiDeleteBackupV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).deleteBackupV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. * @summary Delete a draft * @param {ConfigurationHubApiDeleteDraftV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public deleteDraftV1(requestParameters: ConfigurationHubApiDeleteDraftV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).deleteDraftV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Deletes an object mapping * @param {ConfigurationHubApiDeleteObjectMappingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public deleteObjectMappingV1(requestParameters: ConfigurationHubApiDeleteObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).deleteObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API deletes an existing scheduled action. * @summary Delete scheduled action * @param {ConfigurationHubApiDeleteScheduledActionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public deleteScheduledActionV1(requestParameters: ConfigurationHubApiDeleteScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).deleteScheduledActionV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. * @summary Delete an uploaded configuration * @param {ConfigurationHubApiDeleteUploadedConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public deleteUploadedConfigurationV1(requestParameters: ConfigurationHubApiDeleteUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).deleteUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets an existing deploy for the current tenant. * @summary Get a deploy * @param {ConfigurationHubApiGetDeployV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public getDeployV1(requestParameters: ConfigurationHubApiGetDeployV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).getDeployV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read * @summary Gets list of object mappings * @param {ConfigurationHubApiGetObjectMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public getObjectMappingsV1(requestParameters: ConfigurationHubApiGetObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).getObjectMappingsV1(requestParameters.sourceOrg, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets an existing uploaded configuration for the current tenant. * @summary Get an uploaded configuration * @param {ConfigurationHubApiGetUploadedConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public getUploadedConfigurationV1(requestParameters: ConfigurationHubApiGetUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).getUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets a list of existing backups for the current tenant. * @summary List backups * @param {ConfigurationHubApiListBackupsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public listBackupsV1(requestParameters: ConfigurationHubApiListBackupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).listBackupsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets a list of deploys for the current tenant. * @summary List deploys * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public listDeploysV1(axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).listDeploysV1(axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets a list of existing drafts for the current tenant. * @summary List drafts * @param {ConfigurationHubApiListDraftsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public listDraftsV1(requestParameters: ConfigurationHubApiListDraftsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).listDraftsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets a list of existing scheduled actions for the current tenant. * @summary List scheduled actions * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public listScheduledActionsV1(axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).listScheduledActionsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets a list of existing uploaded configurations for the current tenant. * @summary List uploaded configurations * @param {ConfigurationHubApiListUploadedConfigurationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public listUploadedConfigurationsV1(requestParameters: ConfigurationHubApiListUploadedConfigurationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).listUploadedConfigurationsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage * @summary Bulk updates object mappings * @param {ConfigurationHubApiUpdateObjectMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public updateObjectMappingsV1(requestParameters: ConfigurationHubApiUpdateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).updateObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API updates an existing scheduled action using JSON Patch format. * @summary Update scheduled action * @param {ConfigurationHubApiUpdateScheduledActionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConfigurationHubApi */ public updateScheduledActionV1(requestParameters: ConfigurationHubApiUpdateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConfigurationHubApiFp(this.configuration).updateScheduledActionV1(requestParameters.id, requestParameters.jsonPatch, axiosOptions).then((request) => request(this.axios, this.basePath)); } }