/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - SP-Config * 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'; /** * Config export and import format for individual object configurations. * @export * @interface ConfigObject */ export interface ConfigObject { /** * Current version of configuration object. * @type {number} * @memberof ConfigObject */ 'version'?: number; /** * * @type {SelfImportExportDto} * @memberof ConfigObject */ 'self'?: SelfImportExportDto; /** * Object details. Format dependant on the object type. * @type {{ [key: string]: any; }} * @memberof ConfigObject */ 'object'?: { [key: string]: any; }; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface ExportOptions */ export interface ExportOptions { /** * Object type names to be excluded from an sp-config export command. * @type {Array} * @memberof ExportOptions */ 'excludeTypes'?: Array; /** * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. * @type {Array} * @memberof ExportOptions */ 'includeTypes'?: Array; /** * Additional options targeting specific objects related to each item in the includeTypes field * @type {{ [key: string]: ObjectExportImportOptions; }} * @memberof ExportOptions */ 'objectOptions'?: { [key: string]: ObjectExportImportOptions; }; } export const ExportOptionsExcludeTypesEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', ConnectorRule: 'CONNECTOR_RULE', 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 ExportOptionsExcludeTypesEnum = typeof ExportOptionsExcludeTypesEnum[keyof typeof ExportOptionsExcludeTypesEnum]; export const ExportOptionsIncludeTypesEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', ConnectorRule: 'CONNECTOR_RULE', 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 ExportOptionsIncludeTypesEnum = typeof ExportOptionsIncludeTypesEnum[keyof typeof ExportOptionsIncludeTypesEnum]; /** * * @export * @interface ExportPayload */ export interface ExportPayload { /** * Optional user defined description/name for export job. * @type {string} * @memberof ExportPayload */ 'description'?: string; /** * Object type names to be excluded from an sp-config export command. * @type {Array} * @memberof ExportPayload */ 'excludeTypes'?: Array; /** * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. * @type {Array} * @memberof ExportPayload */ 'includeTypes'?: Array; /** * Additional options targeting specific objects related to each item in the includeTypes field * @type {{ [key: string]: ObjectExportImportOptions; }} * @memberof ExportPayload */ 'objectOptions'?: { [key: string]: ObjectExportImportOptions; }; } export const ExportPayloadExcludeTypesEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', ConnectorRule: 'CONNECTOR_RULE', 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 ExportPayloadExcludeTypesEnum = typeof ExportPayloadExcludeTypesEnum[keyof typeof ExportPayloadExcludeTypesEnum]; export const ExportPayloadIncludeTypesEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', ConnectorRule: 'CONNECTOR_RULE', 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 ExportPayloadIncludeTypesEnum = typeof ExportPayloadIncludeTypesEnum[keyof typeof ExportPayloadIncludeTypesEnum]; /** * * @export * @interface ExportSpConfigV1401Response */ export interface ExportSpConfigV1401Response { /** * A message describing the error * @type {any} * @memberof ExportSpConfigV1401Response */ 'error'?: any; } /** * * @export * @interface ExportSpConfigV1429Response */ export interface ExportSpConfigV1429Response { /** * A message describing the error * @type {any} * @memberof ExportSpConfigV1429Response */ 'message'?: any; } /** * Object created or updated by import. * @export * @interface ImportObject */ export interface ImportObject { /** * DTO type of object created or updated by import. * @type {string} * @memberof ImportObject */ 'type'?: ImportObjectTypeEnum; /** * ID of object created or updated by import. * @type {string} * @memberof ImportObject */ 'id'?: string; /** * Display name of object created or updated by import. * @type {string} * @memberof ImportObject */ 'name'?: string; } export const ImportObjectTypeEnum = { ConnectorRule: 'CONNECTOR_RULE', IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', IdentityProfile: 'IDENTITY_PROFILE', Rule: 'RULE', Source: 'SOURCE', Transform: 'TRANSFORM', TriggerSubscription: 'TRIGGER_SUBSCRIPTION' } as const; export type ImportObjectTypeEnum = typeof ImportObjectTypeEnum[keyof typeof ImportObjectTypeEnum]; /** * * @export * @interface ImportOptions */ export interface ImportOptions { /** * Object type names to be excluded from an sp-config export command. * @type {Array} * @memberof ImportOptions */ 'excludeTypes'?: Array; /** * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. * @type {Array} * @memberof ImportOptions */ 'includeTypes'?: Array; /** * Additional options targeting specific objects related to each item in the includeTypes field * @type {{ [key: string]: ObjectExportImportOptions; }} * @memberof ImportOptions */ 'objectOptions'?: { [key: string]: ObjectExportImportOptions; }; /** * List of object types that can be used to resolve references on import. * @type {Array} * @memberof ImportOptions */ 'defaultReferences'?: Array; /** * By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. * @type {boolean} * @memberof ImportOptions */ 'excludeBackup'?: boolean; } export const ImportOptionsExcludeTypesEnum = { ConnectorRule: 'CONNECTOR_RULE', IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', IdentityProfile: 'IDENTITY_PROFILE', Rule: 'RULE', Source: 'SOURCE', Transform: 'TRANSFORM', TriggerSubscription: 'TRIGGER_SUBSCRIPTION' } as const; export type ImportOptionsExcludeTypesEnum = typeof ImportOptionsExcludeTypesEnum[keyof typeof ImportOptionsExcludeTypesEnum]; export const ImportOptionsIncludeTypesEnum = { ConnectorRule: 'CONNECTOR_RULE', IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', IdentityProfile: 'IDENTITY_PROFILE', Rule: 'RULE', Source: 'SOURCE', Transform: 'TRANSFORM', TriggerSubscription: 'TRIGGER_SUBSCRIPTION' } as const; export type ImportOptionsIncludeTypesEnum = typeof ImportOptionsIncludeTypesEnum[keyof typeof ImportOptionsIncludeTypesEnum]; export const ImportOptionsDefaultReferencesEnum = { ConnectorRule: 'CONNECTOR_RULE', IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', IdentityProfile: 'IDENTITY_PROFILE', Rule: 'RULE', Source: 'SOURCE', Transform: 'TRANSFORM', TriggerSubscription: 'TRIGGER_SUBSCRIPTION' } as const; export type ImportOptionsDefaultReferencesEnum = typeof ImportOptionsDefaultReferencesEnum[keyof typeof ImportOptionsDefaultReferencesEnum]; /** * * @export * @interface ImportSpConfigV1Request */ export interface ImportSpConfigV1Request { /** * JSON file containing the objects to be imported. * @type {File} * @memberof ImportSpConfigV1Request */ 'data': File; /** * * @type {ImportOptions} * @memberof ImportSpConfigV1Request */ 'options'?: ImportOptions; } /** * 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 ObjectExportImportOptions */ export interface ObjectExportImportOptions { /** * Object ids to be included in an import or export. * @type {Array} * @memberof ObjectExportImportOptions */ 'includedIds'?: Array; /** * Object names to be included in an import or export. * @type {Array} * @memberof ObjectExportImportOptions */ 'includedNames'?: Array; } /** * Response model for import of a single object. * @export * @interface ObjectImportResult2 */ export interface ObjectImportResult2 { /** * Informational messages returned from the target service on import. * @type {Array} * @memberof ObjectImportResult2 */ 'infos': Array; /** * Warning messages returned from the target service on import. * @type {Array} * @memberof ObjectImportResult2 */ 'warnings': Array; /** * Error messages returned from the target service on import. * @type {Array} * @memberof ObjectImportResult2 */ 'errors': Array; /** * References to objects that were created or updated by the import. * @type {Array} * @memberof ObjectImportResult2 */ 'importedObjects': Array; } /** * Self block for imported/exported object. * @export * @interface SelfImportExportDto */ export interface SelfImportExportDto { /** * Imported/exported object\'s DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. * @type {string} * @memberof SelfImportExportDto */ 'type'?: SelfImportExportDtoTypeEnum; /** * Imported/exported object\'s ID. * @type {string} * @memberof SelfImportExportDto */ 'id'?: string; /** * Imported/exported object\'s display name. * @type {string} * @memberof SelfImportExportDto */ 'name'?: string; } export const SelfImportExportDtoTypeEnum = { AccessProfile: 'ACCESS_PROFILE', AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', AuthOrg: 'AUTH_ORG', CampaignFilter: 'CAMPAIGN_FILTER', ConnectorRule: 'CONNECTOR_RULE', 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 SelfImportExportDtoTypeEnum = typeof SelfImportExportDtoTypeEnum[keyof typeof SelfImportExportDtoTypeEnum]; /** * * @export * @interface SpConfigExportJob */ export interface SpConfigExportJob { /** * Unique id assigned to this job. * @type {string} * @memberof SpConfigExportJob */ 'jobId': string; /** * Status of the job. * @type {string} * @memberof SpConfigExportJob */ 'status': SpConfigExportJobStatusEnum; /** * Type of the job, either export or import. * @type {string} * @memberof SpConfigExportJob */ 'type': SpConfigExportJobTypeEnum; /** * The time until which the artifacts will be available for download. * @type {string} * @memberof SpConfigExportJob */ 'expiration'?: string; /** * The time the job was started. * @type {string} * @memberof SpConfigExportJob */ 'created': string; /** * The time of the last update to the job. * @type {string} * @memberof SpConfigExportJob */ 'modified': string; /** * Optional user defined description/name for export job. * @type {string} * @memberof SpConfigExportJob */ 'description'?: string; } export const SpConfigExportJobStatusEnum = { NotStarted: 'NOT_STARTED', InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', Cancelled: 'CANCELLED', Failed: 'FAILED' } as const; export type SpConfigExportJobStatusEnum = typeof SpConfigExportJobStatusEnum[keyof typeof SpConfigExportJobStatusEnum]; export const SpConfigExportJobTypeEnum = { Export: 'EXPORT', Import: 'IMPORT' } as const; export type SpConfigExportJobTypeEnum = typeof SpConfigExportJobTypeEnum[keyof typeof SpConfigExportJobTypeEnum]; /** * * @export * @interface SpConfigExportJobStatus */ export interface SpConfigExportJobStatus { /** * Unique id assigned to this job. * @type {string} * @memberof SpConfigExportJobStatus */ 'jobId': string; /** * Status of the job. * @type {string} * @memberof SpConfigExportJobStatus */ 'status': SpConfigExportJobStatusStatusEnum; /** * Type of the job, either export or import. * @type {string} * @memberof SpConfigExportJobStatus */ 'type': SpConfigExportJobStatusTypeEnum; /** * The time until which the artifacts will be available for download. * @type {string} * @memberof SpConfigExportJobStatus */ 'expiration'?: string; /** * The time the job was started. * @type {string} * @memberof SpConfigExportJobStatus */ 'created': string; /** * The time of the last update to the job. * @type {string} * @memberof SpConfigExportJobStatus */ 'modified': string; /** * Optional user defined description/name for export job. * @type {string} * @memberof SpConfigExportJobStatus */ 'description'?: string; /** * The time the job was completed. * @type {string} * @memberof SpConfigExportJobStatus */ 'completed'?: string; } export const SpConfigExportJobStatusStatusEnum = { NotStarted: 'NOT_STARTED', InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', Cancelled: 'CANCELLED', Failed: 'FAILED' } as const; export type SpConfigExportJobStatusStatusEnum = typeof SpConfigExportJobStatusStatusEnum[keyof typeof SpConfigExportJobStatusStatusEnum]; export const SpConfigExportJobStatusTypeEnum = { Export: 'EXPORT', Import: 'IMPORT' } as const; export type SpConfigExportJobStatusTypeEnum = typeof SpConfigExportJobStatusTypeEnum[keyof typeof SpConfigExportJobStatusTypeEnum]; /** * Response model for config export download response. * @export * @interface SpConfigExportResults */ export interface SpConfigExportResults { /** * Current version of the export results object. * @type {number} * @memberof SpConfigExportResults */ 'version'?: number; /** * Time the export was completed. * @type {string} * @memberof SpConfigExportResults */ 'timestamp'?: string; /** * Name of the tenant where this export originated. * @type {string} * @memberof SpConfigExportResults */ 'tenant'?: string; /** * Optional user defined description/name for export job. * @type {string} * @memberof SpConfigExportResults */ 'description'?: string; /** * * @type {ExportOptions} * @memberof SpConfigExportResults */ 'options'?: ExportOptions; /** * * @type {Array} * @memberof SpConfigExportResults */ 'objects'?: Array; } /** * * @export * @interface SpConfigImportJobStatus */ export interface SpConfigImportJobStatus { /** * Unique id assigned to this job. * @type {string} * @memberof SpConfigImportJobStatus */ 'jobId': string; /** * Status of the job. * @type {string} * @memberof SpConfigImportJobStatus */ 'status': SpConfigImportJobStatusStatusEnum; /** * Type of the job, either export or import. * @type {string} * @memberof SpConfigImportJobStatus */ 'type': SpConfigImportJobStatusTypeEnum; /** * The time until which the artifacts will be available for download. * @type {string} * @memberof SpConfigImportJobStatus */ 'expiration'?: string; /** * The time the job was started. * @type {string} * @memberof SpConfigImportJobStatus */ 'created': string; /** * The time of the last update to the job. * @type {string} * @memberof SpConfigImportJobStatus */ 'modified': string; /** * This message contains additional information about the overall status of the job. * @type {string} * @memberof SpConfigImportJobStatus */ 'message'?: string; /** * The time the job was completed. * @type {string} * @memberof SpConfigImportJobStatus */ 'completed'?: string; } export const SpConfigImportJobStatusStatusEnum = { NotStarted: 'NOT_STARTED', InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', Cancelled: 'CANCELLED', Failed: 'FAILED' } as const; export type SpConfigImportJobStatusStatusEnum = typeof SpConfigImportJobStatusStatusEnum[keyof typeof SpConfigImportJobStatusStatusEnum]; export const SpConfigImportJobStatusTypeEnum = { Export: 'EXPORT', Import: 'IMPORT' } as const; export type SpConfigImportJobStatusTypeEnum = typeof SpConfigImportJobStatusTypeEnum[keyof typeof SpConfigImportJobStatusTypeEnum]; /** * Response Body for Config Import command. * @export * @interface SpConfigImportResults */ export interface SpConfigImportResults { /** * The results of an object configuration import job. * @type {{ [key: string]: ObjectImportResult2; }} * @memberof SpConfigImportResults */ 'results': { [key: string]: ObjectImportResult2; }; /** * If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. * @type {string} * @memberof SpConfigImportResults */ 'exportJobId'?: string; } /** * * @export * @interface SpConfigJob */ export interface SpConfigJob { /** * Unique id assigned to this job. * @type {string} * @memberof SpConfigJob */ 'jobId': string; /** * Status of the job. * @type {string} * @memberof SpConfigJob */ 'status': SpConfigJobStatusEnum; /** * Type of the job, either export or import. * @type {string} * @memberof SpConfigJob */ 'type': SpConfigJobTypeEnum; /** * The time until which the artifacts will be available for download. * @type {string} * @memberof SpConfigJob */ 'expiration'?: string; /** * The time the job was started. * @type {string} * @memberof SpConfigJob */ 'created': string; /** * The time of the last update to the job. * @type {string} * @memberof SpConfigJob */ 'modified': string; } export const SpConfigJobStatusEnum = { NotStarted: 'NOT_STARTED', InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', Cancelled: 'CANCELLED', Failed: 'FAILED' } as const; export type SpConfigJobStatusEnum = typeof SpConfigJobStatusEnum[keyof typeof SpConfigJobStatusEnum]; export const SpConfigJobTypeEnum = { Export: 'EXPORT', Import: 'IMPORT' } as const; export type SpConfigJobTypeEnum = typeof SpConfigJobTypeEnum[keyof typeof SpConfigJobTypeEnum]; /** * Message model for Config Import/Export. * @export * @interface SpConfigMessage2 */ export interface SpConfigMessage2 { /** * Message key. * @type {string} * @memberof SpConfigMessage2 */ 'key': string; /** * Message text. * @type {string} * @memberof SpConfigMessage2 */ 'text': string; /** * Message details if any, in key:value pairs. * @type {{ [key: string]: object; }} * @memberof SpConfigMessage2 */ 'details': { [key: string]: object; }; } /** * Response model for object configuration. * @export * @interface SpConfigObject */ export interface SpConfigObject { /** * Object type the configuration is for. * @type {string} * @memberof SpConfigObject */ 'objectType'?: string; /** * List of JSON paths within an exported object of this type, representing references that must be resolved. * @type {Array} * @memberof SpConfigObject */ 'referenceExtractors'?: Array | null; /** * Indicates whether this type of object will be JWS signed and cannot be modified before import. * @type {boolean} * @memberof SpConfigObject */ 'signatureRequired'?: boolean; /** * Indicates whether this object type must be always be resolved by ID. * @type {boolean} * @memberof SpConfigObject */ 'alwaysResolveById'?: boolean; /** * Indicates whether this is a legacy object. * @type {boolean} * @memberof SpConfigObject */ 'legacyObject'?: boolean; /** * Indicates whether there is only one object of this type. * @type {boolean} * @memberof SpConfigObject */ 'onePerTenant'?: boolean; /** * Indicates whether the object can be exported or is just a reference object. * @type {boolean} * @memberof SpConfigObject */ 'exportable'?: boolean; /** * * @type {SpConfigRules} * @memberof SpConfigObject */ 'rules'?: SpConfigRules; } /** * Format of Config Hub object rules. * @export * @interface SpConfigRule */ export interface SpConfigRule { /** * JSONPath expression denoting the path within the object where a value substitution should be applied. * @type {string} * @memberof SpConfigRule */ 'path'?: string; /** * * @type {SpConfigRuleValue} * @memberof SpConfigRule */ 'value'?: SpConfigRuleValue | null; /** * Draft modes the rule will apply to. * @type {Array} * @memberof SpConfigRule */ 'modes'?: Array; } export const SpConfigRuleModesEnum = { Restore: 'RESTORE', Promote: 'PROMOTE', Upload: 'UPLOAD' } as const; export type SpConfigRuleModesEnum = typeof SpConfigRuleModesEnum[keyof typeof SpConfigRuleModesEnum]; /** * Value to be assigned at the jsonPath location within the object. * @export * @interface SpConfigRuleValue */ export interface SpConfigRuleValue { } /** * Rules to be applied to the config object during the draft process. * @export * @interface SpConfigRules */ export interface SpConfigRules { /** * * @type {Array} * @memberof SpConfigRules */ 'takeFromTargetRules'?: Array; /** * * @type {Array} * @memberof SpConfigRules */ 'defaultRules'?: Array; /** * Indicates whether the object can be edited. * @type {boolean} * @memberof SpConfigRules */ 'editable'?: boolean; } /** * SPConfigApi - axios parameter creator * @export */ export const SPConfigApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects export job * @param {ExportPayload} exportPayload Export options control what will be included in the export. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportSpConfigV1: async (exportPayload: ExportPayload, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'exportPayload' is not null or undefined assertParamExists('exportSpConfigV1', 'exportPayload', exportPayload) const localVarPath = `/sp-config/v1/export`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: '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(exportPayload, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Get export job status * @param {string} id The ID of the export job whose status will be returned. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigExportStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getSpConfigExportStatusV1', 'id', id) const localVarPath = `/sp-config/v1/export/{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 endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Download export job result. * @param {string} id The ID of the export job whose results will be downloaded. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigExportV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getSpConfigExportV1', 'id', id) const localVarPath = `/sp-config/v1/export/{id}/download` .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 the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' * @summary Get import job status * @param {string} id The ID of the import job whose status will be returned. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigImportStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getSpConfigImportStatusV1', 'id', id) const localVarPath = `/sp-config/v1/import/{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 import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage * @summary Download import job result * @param {string} id The ID of the import job whose results will be downloaded. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigImportV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getSpConfigImportV1', 'id', id) const localVarPath = `/sp-config/v1/import/{id}/download` .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 post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects import job * @param {File} data JSON file containing the objects to be imported. * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. * @param {ImportOptions} [_options] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importSpConfigV1: async (data: File, preview?: boolean, _options?: ImportOptions, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'data' is not null or undefined assertParamExists('importSpConfigV1', 'data', data) const localVarPath = `/sp-config/v1/import`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); if (preview !== undefined) { localVarQueryParameter['preview'] = preview; } if (data !== undefined) { localVarFormParams.append('data', data as any); } if (_options !== undefined) { localVarFormParams.append('options', new Blob([JSON.stringify(_options)], { type: "application/json", })); } 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, }; }, /** * Get a list of object configurations that the tenant export/import service knows. * @summary List config objects * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSpConfigObjectsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/sp-config/v1/config-objects`; // 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, }; }, } }; /** * SPConfigApi - functional programming interface * @export */ export const SPConfigApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = SPConfigApiAxiosParamCreator(configuration) return { /** * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects export job * @param {ExportPayload} exportPayload Export options control what will be included in the export. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async exportSpConfigV1(exportPayload: ExportPayload, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.exportSpConfigV1(exportPayload, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SPConfigApi.exportSpConfigV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Get export job status * @param {string} id The ID of the export job whose status will be returned. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getSpConfigExportStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportStatusV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SPConfigApi.getSpConfigExportStatusV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Download export job result. * @param {string} id The ID of the export job whose results will be downloaded. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getSpConfigExportV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SPConfigApi.getSpConfigExportV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' * @summary Get import job status * @param {string} id The ID of the import job whose status will be returned. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getSpConfigImportStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportStatusV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SPConfigApi.getSpConfigImportStatusV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage * @summary Download import job result * @param {string} id The ID of the import job whose results will be downloaded. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getSpConfigImportV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SPConfigApi.getSpConfigImportV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects import job * @param {File} data JSON file containing the objects to be imported. * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. * @param {ImportOptions} [_options] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async importSpConfigV1(data: File, preview?: boolean, _options?: ImportOptions, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.importSpConfigV1(data, preview, _options, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SPConfigApi.importSpConfigV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a list of object configurations that the tenant export/import service knows. * @summary List config objects * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listSpConfigObjectsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listSpConfigObjectsV1(axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SPConfigApi.listSpConfigObjectsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * SPConfigApi - factory interface * @export */ export const SPConfigApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = SPConfigApiFp(configuration) return { /** * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects export job * @param {SPConfigApiExportSpConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportSpConfigV1(requestParameters: SPConfigApiExportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.exportSpConfigV1(requestParameters.exportPayload, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Get export job status * @param {SPConfigApiGetSpConfigExportStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigExportStatusV1(requestParameters: SPConfigApiGetSpConfigExportStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getSpConfigExportStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Download export job result. * @param {SPConfigApiGetSpConfigExportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigExportV1(requestParameters: SPConfigApiGetSpConfigExportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getSpConfigExportV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' * @summary Get import job status * @param {SPConfigApiGetSpConfigImportStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigImportStatusV1(requestParameters: SPConfigApiGetSpConfigImportStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getSpConfigImportStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage * @summary Download import job result * @param {SPConfigApiGetSpConfigImportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSpConfigImportV1(requestParameters: SPConfigApiGetSpConfigImportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getSpConfigImportV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects import job * @param {SPConfigApiImportSpConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importSpConfigV1(requestParameters: SPConfigApiImportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.importSpConfigV1(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a list of object configurations that the tenant export/import service knows. * @summary List config objects * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSpConfigObjectsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listSpConfigObjectsV1(axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for exportSpConfigV1 operation in SPConfigApi. * @export * @interface SPConfigApiExportSpConfigV1Request */ export interface SPConfigApiExportSpConfigV1Request { /** * Export options control what will be included in the export. * @type {ExportPayload} * @memberof SPConfigApiExportSpConfigV1 */ readonly exportPayload: ExportPayload } /** * Request parameters for getSpConfigExportStatusV1 operation in SPConfigApi. * @export * @interface SPConfigApiGetSpConfigExportStatusV1Request */ export interface SPConfigApiGetSpConfigExportStatusV1Request { /** * The ID of the export job whose status will be returned. * @type {string} * @memberof SPConfigApiGetSpConfigExportStatusV1 */ readonly id: string } /** * Request parameters for getSpConfigExportV1 operation in SPConfigApi. * @export * @interface SPConfigApiGetSpConfigExportV1Request */ export interface SPConfigApiGetSpConfigExportV1Request { /** * The ID of the export job whose results will be downloaded. * @type {string} * @memberof SPConfigApiGetSpConfigExportV1 */ readonly id: string } /** * Request parameters for getSpConfigImportStatusV1 operation in SPConfigApi. * @export * @interface SPConfigApiGetSpConfigImportStatusV1Request */ export interface SPConfigApiGetSpConfigImportStatusV1Request { /** * The ID of the import job whose status will be returned. * @type {string} * @memberof SPConfigApiGetSpConfigImportStatusV1 */ readonly id: string } /** * Request parameters for getSpConfigImportV1 operation in SPConfigApi. * @export * @interface SPConfigApiGetSpConfigImportV1Request */ export interface SPConfigApiGetSpConfigImportV1Request { /** * The ID of the import job whose results will be downloaded. * @type {string} * @memberof SPConfigApiGetSpConfigImportV1 */ readonly id: string } /** * Request parameters for importSpConfigV1 operation in SPConfigApi. * @export * @interface SPConfigApiImportSpConfigV1Request */ export interface SPConfigApiImportSpConfigV1Request { /** * JSON file containing the objects to be imported. * @type {File} * @memberof SPConfigApiImportSpConfigV1 */ readonly data: File /** * This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. * @type {boolean} * @memberof SPConfigApiImportSpConfigV1 */ readonly preview?: boolean /** * * @type {ImportOptions} * @memberof SPConfigApiImportSpConfigV1 */ readonly _options?: ImportOptions } /** * SPConfigApi - object-oriented interface * @export * @class SPConfigApi * @extends {BaseAPI} */ export class SPConfigApi extends BaseAPI { /** * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects export job * @param {SPConfigApiExportSpConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SPConfigApi */ public exportSpConfigV1(requestParameters: SPConfigApiExportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { return SPConfigApiFp(this.configuration).exportSpConfigV1(requestParameters.exportPayload, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Get export job status * @param {SPConfigApiGetSpConfigExportStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SPConfigApi */ public getSpConfigExportStatusV1(requestParameters: SPConfigApiGetSpConfigExportStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { return SPConfigApiFp(this.configuration).getSpConfigExportStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage * @summary Download export job result. * @param {SPConfigApiGetSpConfigExportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SPConfigApi */ public getSpConfigExportV1(requestParameters: SPConfigApiGetSpConfigExportV1Request, axiosOptions?: RawAxiosRequestConfig) { return SPConfigApiFp(this.configuration).getSpConfigExportV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' * @summary Get import job status * @param {SPConfigApiGetSpConfigImportStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SPConfigApi */ public getSpConfigImportStatusV1(requestParameters: SPConfigApiGetSpConfigImportStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { return SPConfigApiFp(this.configuration).getSpConfigImportStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage * @summary Download import job result * @param {SPConfigApiGetSpConfigImportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SPConfigApi */ public getSpConfigImportV1(requestParameters: SPConfigApiGetSpConfigImportV1Request, axiosOptions?: RawAxiosRequestConfig) { return SPConfigApiFp(this.configuration).getSpConfigImportV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). * @summary Initiates configuration objects import job * @param {SPConfigApiImportSpConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SPConfigApi */ public importSpConfigV1(requestParameters: SPConfigApiImportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { return SPConfigApiFp(this.configuration).importSpConfigV1(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a list of object configurations that the tenant export/import service knows. * @summary List config objects * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SPConfigApi */ public listSpConfigObjectsV1(axiosOptions?: RawAxiosRequestConfig) { return SPConfigApiFp(this.configuration).listSpConfigObjectsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); } }