/** * Identity Security Cloud API - Connectors * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface ConnectorDetail */ export interface ConnectorDetail { /** * The connector name * @type {string} * @memberof ConnectorDetail */ 'name'?: string; /** * The connector type * @type {string} * @memberof ConnectorDetail */ 'type'?: string; /** * The connector class name * @type {string} * @memberof ConnectorDetail */ 'className'?: string; /** * The connector script name * @type {string} * @memberof ConnectorDetail */ 'scriptName'?: string; /** * The connector application xml * @type {string} * @memberof ConnectorDetail */ 'applicationXml'?: string; /** * The connector correlation config xml * @type {string} * @memberof ConnectorDetail */ 'correlationConfigXml'?: string; /** * The connector source config xml * @type {string} * @memberof ConnectorDetail */ 'sourceConfigXml'?: string; /** * The connector source config * @type {string} * @memberof ConnectorDetail */ 'sourceConfig'?: string | null; /** * The connector source config origin * @type {string} * @memberof ConnectorDetail */ 'sourceConfigFrom'?: string | null; /** * storage path key for this connector * @type {string} * @memberof ConnectorDetail */ 's3Location'?: string; /** * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. * @type {Array} * @memberof ConnectorDetail */ 'uploadedFiles'?: Array | null; /** * true if the source is file upload * @type {boolean} * @memberof ConnectorDetail */ 'fileUpload'?: boolean; /** * true if the source is a direct connect source * @type {boolean} * @memberof ConnectorDetail */ 'directConnect'?: boolean; /** * A map containing translation attributes by loacale key * @type {{ [key: string]: any; }} * @memberof ConnectorDetail */ 'translationProperties'?: { [key: string]: any; }; /** * A map containing metadata pertinent to the UI to be used * @type {{ [key: string]: any; }} * @memberof ConnectorDetail */ 'connectorMetadata'?: { [key: string]: any; }; /** * The connector status * @type {string} * @memberof ConnectorDetail */ 'status'?: ConnectorDetailStatusEnum; } export declare const ConnectorDetailStatusEnum: { readonly Deprecated: "DEPRECATED"; readonly Development: "DEVELOPMENT"; readonly Demo: "DEMO"; readonly Released: "RELEASED"; }; export type ConnectorDetailStatusEnum = typeof ConnectorDetailStatusEnum[keyof typeof ConnectorDetailStatusEnum]; /** * * @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 GetConnectorV1401Response */ export interface GetConnectorV1401Response { /** * A message describing the error * @type {any} * @memberof GetConnectorV1401Response */ 'error'?: any; } /** * * @export * @interface GetConnectorV1429Response */ export interface GetConnectorV1429Response { /** * A message describing the error * @type {any} * @memberof GetConnectorV1429Response */ 'message'?: any; } /** * 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 declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; 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; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface PutConnectorCorrelationConfigV1Request */ export interface PutConnectorCorrelationConfigV1Request { /** * connector correlation config xml file * @type {File} * @memberof PutConnectorCorrelationConfigV1Request */ 'file': File; } /** * * @export * @interface PutConnectorSourceConfigV1Request */ export interface PutConnectorSourceConfigV1Request { /** * connector source config xml file * @type {File} * @memberof PutConnectorSourceConfigV1Request */ 'file': File; } /** * * @export * @interface PutConnectorSourceTemplateV1Request */ export interface PutConnectorSourceTemplateV1Request { /** * connector source template xml file * @type {File} * @memberof PutConnectorSourceTemplateV1Request */ 'file': File; } /** * * @export * @interface UpdateDetail */ export interface UpdateDetail { /** * The detailed message for an update. Typically the relevent error message when status is error. * @type {string} * @memberof UpdateDetail */ 'message'?: string; /** * The connector script name * @type {string} * @memberof UpdateDetail */ 'scriptName'?: string; /** * The list of updated files supported by the connector * @type {Array} * @memberof UpdateDetail */ 'updatedFiles'?: Array | null; /** * The connector update status * @type {string} * @memberof UpdateDetail */ 'status'?: UpdateDetailStatusEnum; } export declare const UpdateDetailStatusEnum: { readonly Error: "ERROR"; readonly Updated: "UPDATED"; readonly Unchanged: "UNCHANGED"; readonly Skipped: "SKIPPED"; }; export type UpdateDetailStatusEnum = typeof UpdateDetailStatusEnum[keyof typeof UpdateDetailStatusEnum]; /** * * @export * @interface V3ConnectorDto */ export interface V3ConnectorDto { /** * The connector name * @type {string} * @memberof V3ConnectorDto */ 'name'?: string; /** * The connector type * @type {string} * @memberof V3ConnectorDto */ 'type'?: string; /** * The connector script name * @type {string} * @memberof V3ConnectorDto */ 'scriptName'?: string; /** * The connector class name. * @type {string} * @memberof V3ConnectorDto */ 'className'?: string | null; /** * The list of features supported by the connector * @type {Array} * @memberof V3ConnectorDto */ 'features'?: Array | null; /** * true if the source is a direct connect source * @type {boolean} * @memberof V3ConnectorDto */ 'directConnect'?: boolean; /** * A map containing metadata pertinent to the connector * @type {{ [key: string]: any; }} * @memberof V3ConnectorDto */ 'connectorMetadata'?: { [key: string]: any; }; /** * The connector status * @type {string} * @memberof V3ConnectorDto */ 'status'?: V3ConnectorDtoStatusEnum; } export declare const V3ConnectorDtoStatusEnum: { readonly Deprecated: "DEPRECATED"; readonly Development: "DEVELOPMENT"; readonly Demo: "DEMO"; readonly Released: "RELEASED"; }; export type V3ConnectorDtoStatusEnum = typeof V3ConnectorDtoStatusEnum[keyof typeof V3ConnectorDtoStatusEnum]; /** * * @export * @interface V3CreateConnectorDto */ export interface V3CreateConnectorDto { /** * The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints * @type {string} * @memberof V3CreateConnectorDto */ 'name': string; /** * The connector type. If not specified will be defaulted to \'custom \'+name * @type {string} * @memberof V3CreateConnectorDto */ 'type'?: string; /** * The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter * @type {string} * @memberof V3CreateConnectorDto */ 'className': string; /** * true if the source is a direct connect source * @type {boolean} * @memberof V3CreateConnectorDto */ 'directConnect'?: boolean; /** * The connector status * @type {string} * @memberof V3CreateConnectorDto */ 'status'?: V3CreateConnectorDtoStatusEnum; } export declare const V3CreateConnectorDtoStatusEnum: { readonly Development: "DEVELOPMENT"; readonly Demo: "DEMO"; readonly Released: "RELEASED"; }; export type V3CreateConnectorDtoStatusEnum = typeof V3CreateConnectorDtoStatusEnum[keyof typeof V3CreateConnectorDtoStatusEnum]; /** * ConnectorsApi - axios parameter creator * @export */ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create custom connector. * @summary Create custom connector * @param {V3CreateConnectorDto} v3CreateConnectorDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCustomConnectorV1: (v3CreateConnectorDto: V3CreateConnectorDto, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a custom connector that using its script name. * @summary Delete connector by script name * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteCustomConnectorV1: (scriptName: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Fetches a connector\'s correlation config using its script name. * @summary Get connector correlation configuration * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorCorrelationConfigV1: (scriptName: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. * @summary Get connector list * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {GetConnectorListV1LocaleEnum} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorListV1: (filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Fetches a connector\'s source config using its script name. * @summary Get connector source configuration * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorSourceConfigV1: (scriptName: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Fetches a connector\'s source template using its script name. * @summary Get connector source template * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorSourceTemplateV1: (scriptName: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Fetches a connector\'s translations using its script name. * @summary Get connector translations * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {GetConnectorTranslationsV1LocaleEnum} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorTranslationsV1: (scriptName: string, locale: GetConnectorTranslationsV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Fetches a connector that using its script name. * @summary Get connector by script name * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {GetConnectorV1LocaleEnum} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorV1: (scriptName: string, locale?: GetConnectorV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a connector\'s correlation config using its script name. * @summary Update connector correlation configuration * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {File} file connector correlation config xml file * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorCorrelationConfigV1: (scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a connector\'s source config using its script name. * @summary Update connector source configuration * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {File} file connector source config xml file * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorSourceConfigV1: (scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a connector\'s source template using its script name. * @summary Update connector source template * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {File} file connector source template xml file * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorSourceTemplateV1: (scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a connector\'s translations using its script name. * @summary Update connector translations * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {PutConnectorTranslationsV1LocaleEnum} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorTranslationsV1: (scriptName: string, locale: PutConnectorTranslationsV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml * @summary Update connector by script name * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {Array} jsonPatchOperation A list of connector detail update operations * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateConnectorV1: (scriptName: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ConnectorsApi - functional programming interface * @export */ export declare const ConnectorsApiFp: (configuration?: Configuration) => { /** * Create custom connector. * @summary Create custom connector * @param {V3CreateConnectorDto} v3CreateConnectorDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCustomConnectorV1(v3CreateConnectorDto: V3CreateConnectorDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a custom connector that using its script name. * @summary Delete connector by script name * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteCustomConnectorV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a connector\'s correlation config using its script name. * @summary Get connector correlation configuration * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorCorrelationConfigV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. * @summary Get connector list * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {GetConnectorListV1LocaleEnum} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorListV1(filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Fetches a connector\'s source config using its script name. * @summary Get connector source configuration * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorSourceConfigV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a connector\'s source template using its script name. * @summary Get connector source template * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorSourceTemplateV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a connector\'s translations using its script name. * @summary Get connector translations * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {GetConnectorTranslationsV1LocaleEnum} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorTranslationsV1(scriptName: string, locale: GetConnectorTranslationsV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches a connector that using its script name. * @summary Get connector by script name * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {GetConnectorV1LocaleEnum} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorV1(scriptName: string, locale?: GetConnectorV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a connector\'s correlation config using its script name. * @summary Update connector correlation configuration * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {File} file connector correlation config xml file * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorCorrelationConfigV1(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a connector\'s source config using its script name. * @summary Update connector source configuration * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {File} file connector source config xml file * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorSourceConfigV1(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a connector\'s source template using its script name. * @summary Update connector source template * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {File} file connector source template xml file * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorSourceTemplateV1(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a connector\'s translations using its script name. * @summary Update connector translations * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @param {PutConnectorTranslationsV1LocaleEnum} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorTranslationsV1(scriptName: string, locale: PutConnectorTranslationsV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml * @summary Update connector by script name * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @param {Array} jsonPatchOperation A list of connector detail update operations * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateConnectorV1(scriptName: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConnectorsApi - factory interface * @export */ export declare const ConnectorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create custom connector. * @summary Create custom connector * @param {ConnectorsApiCreateCustomConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCustomConnectorV1(requestParameters: ConnectorsApiCreateCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a custom connector that using its script name. * @summary Delete connector by script name * @param {ConnectorsApiDeleteCustomConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteCustomConnectorV1(requestParameters: ConnectorsApiDeleteCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a connector\'s correlation config using its script name. * @summary Get connector correlation configuration * @param {ConnectorsApiGetConnectorCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorCorrelationConfigV1(requestParameters: ConnectorsApiGetConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. * @summary Get connector list * @param {ConnectorsApiGetConnectorListV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorListV1(requestParameters?: ConnectorsApiGetConnectorListV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Fetches a connector\'s source config using its script name. * @summary Get connector source configuration * @param {ConnectorsApiGetConnectorSourceConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorSourceConfigV1(requestParameters: ConnectorsApiGetConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a connector\'s source template using its script name. * @summary Get connector source template * @param {ConnectorsApiGetConnectorSourceTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorSourceTemplateV1(requestParameters: ConnectorsApiGetConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a connector\'s translations using its script name. * @summary Get connector translations * @param {ConnectorsApiGetConnectorTranslationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorTranslationsV1(requestParameters: ConnectorsApiGetConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches a connector that using its script name. * @summary Get connector by script name * @param {ConnectorsApiGetConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorV1(requestParameters: ConnectorsApiGetConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a connector\'s correlation config using its script name. * @summary Update connector correlation configuration * @param {ConnectorsApiPutConnectorCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorCorrelationConfigV1(requestParameters: ConnectorsApiPutConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a connector\'s source config using its script name. * @summary Update connector source configuration * @param {ConnectorsApiPutConnectorSourceConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorSourceConfigV1(requestParameters: ConnectorsApiPutConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a connector\'s source template using its script name. * @summary Update connector source template * @param {ConnectorsApiPutConnectorSourceTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorSourceTemplateV1(requestParameters: ConnectorsApiPutConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a connector\'s translations using its script name. * @summary Update connector translations * @param {ConnectorsApiPutConnectorTranslationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorTranslationsV1(requestParameters: ConnectorsApiPutConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml * @summary Update connector by script name * @param {ConnectorsApiUpdateConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateConnectorV1(requestParameters: ConnectorsApiUpdateConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createCustomConnectorV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiCreateCustomConnectorV1Request */ export interface ConnectorsApiCreateCustomConnectorV1Request { /** * * @type {V3CreateConnectorDto} * @memberof ConnectorsApiCreateCustomConnectorV1 */ readonly v3CreateConnectorDto: V3CreateConnectorDto; } /** * Request parameters for deleteCustomConnectorV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiDeleteCustomConnectorV1Request */ export interface ConnectorsApiDeleteCustomConnectorV1Request { /** * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiDeleteCustomConnectorV1 */ readonly scriptName: string; } /** * Request parameters for getConnectorCorrelationConfigV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiGetConnectorCorrelationConfigV1Request */ export interface ConnectorsApiGetConnectorCorrelationConfigV1Request { /** * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiGetConnectorCorrelationConfigV1 */ readonly scriptName: string; } /** * Request parameters for getConnectorListV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiGetConnectorListV1Request */ export interface ConnectorsApiGetConnectorListV1Request { /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* * @type {string} * @memberof ConnectorsApiGetConnectorListV1 */ readonly filters?: string; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ConnectorsApiGetConnectorListV1 */ readonly limit?: number; /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ConnectorsApiGetConnectorListV1 */ readonly offset?: number; /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof ConnectorsApiGetConnectorListV1 */ readonly count?: boolean; /** * The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} * @memberof ConnectorsApiGetConnectorListV1 */ readonly locale?: GetConnectorListV1LocaleEnum; } /** * Request parameters for getConnectorSourceConfigV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiGetConnectorSourceConfigV1Request */ export interface ConnectorsApiGetConnectorSourceConfigV1Request { /** * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiGetConnectorSourceConfigV1 */ readonly scriptName: string; } /** * Request parameters for getConnectorSourceTemplateV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiGetConnectorSourceTemplateV1Request */ export interface ConnectorsApiGetConnectorSourceTemplateV1Request { /** * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiGetConnectorSourceTemplateV1 */ readonly scriptName: string; } /** * Request parameters for getConnectorTranslationsV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiGetConnectorTranslationsV1Request */ export interface ConnectorsApiGetConnectorTranslationsV1Request { /** * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiGetConnectorTranslationsV1 */ readonly scriptName: string; /** * The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} * @memberof ConnectorsApiGetConnectorTranslationsV1 */ readonly locale: GetConnectorTranslationsV1LocaleEnum; } /** * Request parameters for getConnectorV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiGetConnectorV1Request */ export interface ConnectorsApiGetConnectorV1Request { /** * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiGetConnectorV1 */ readonly scriptName: string; /** * The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} * @memberof ConnectorsApiGetConnectorV1 */ readonly locale?: GetConnectorV1LocaleEnum; } /** * Request parameters for putConnectorCorrelationConfigV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiPutConnectorCorrelationConfigV1Request */ export interface ConnectorsApiPutConnectorCorrelationConfigV1Request { /** * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiPutConnectorCorrelationConfigV1 */ readonly scriptName: string; /** * connector correlation config xml file * @type {File} * @memberof ConnectorsApiPutConnectorCorrelationConfigV1 */ readonly file: File; } /** * Request parameters for putConnectorSourceConfigV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiPutConnectorSourceConfigV1Request */ export interface ConnectorsApiPutConnectorSourceConfigV1Request { /** * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiPutConnectorSourceConfigV1 */ readonly scriptName: string; /** * connector source config xml file * @type {File} * @memberof ConnectorsApiPutConnectorSourceConfigV1 */ readonly file: File; } /** * Request parameters for putConnectorSourceTemplateV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiPutConnectorSourceTemplateV1Request */ export interface ConnectorsApiPutConnectorSourceTemplateV1Request { /** * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiPutConnectorSourceTemplateV1 */ readonly scriptName: string; /** * connector source template xml file * @type {File} * @memberof ConnectorsApiPutConnectorSourceTemplateV1 */ readonly file: File; } /** * Request parameters for putConnectorTranslationsV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiPutConnectorTranslationsV1Request */ export interface ConnectorsApiPutConnectorTranslationsV1Request { /** * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiPutConnectorTranslationsV1 */ readonly scriptName: string; /** * The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} * @memberof ConnectorsApiPutConnectorTranslationsV1 */ readonly locale: PutConnectorTranslationsV1LocaleEnum; } /** * Request parameters for updateConnectorV1 operation in ConnectorsApi. * @export * @interface ConnectorsApiUpdateConnectorV1Request */ export interface ConnectorsApiUpdateConnectorV1Request { /** * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. * @type {string} * @memberof ConnectorsApiUpdateConnectorV1 */ readonly scriptName: string; /** * A list of connector detail update operations * @type {Array} * @memberof ConnectorsApiUpdateConnectorV1 */ readonly jsonPatchOperation: Array; } /** * ConnectorsApi - object-oriented interface * @export * @class ConnectorsApi * @extends {BaseAPI} */ export declare class ConnectorsApi extends BaseAPI { /** * Create custom connector. * @summary Create custom connector * @param {ConnectorsApiCreateCustomConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ createCustomConnectorV1(requestParameters: ConnectorsApiCreateCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a custom connector that using its script name. * @summary Delete connector by script name * @param {ConnectorsApiDeleteCustomConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ deleteCustomConnectorV1(requestParameters: ConnectorsApiDeleteCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Fetches a connector\'s correlation config using its script name. * @summary Get connector correlation configuration * @param {ConnectorsApiGetConnectorCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ getConnectorCorrelationConfigV1(requestParameters: ConnectorsApiGetConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. * @summary Get connector list * @param {ConnectorsApiGetConnectorListV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ getConnectorListV1(requestParameters?: ConnectorsApiGetConnectorListV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Fetches a connector\'s source config using its script name. * @summary Get connector source configuration * @param {ConnectorsApiGetConnectorSourceConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ getConnectorSourceConfigV1(requestParameters: ConnectorsApiGetConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Fetches a connector\'s source template using its script name. * @summary Get connector source template * @param {ConnectorsApiGetConnectorSourceTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ getConnectorSourceTemplateV1(requestParameters: ConnectorsApiGetConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Fetches a connector\'s translations using its script name. * @summary Get connector translations * @param {ConnectorsApiGetConnectorTranslationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ getConnectorTranslationsV1(requestParameters: ConnectorsApiGetConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Fetches a connector that using its script name. * @summary Get connector by script name * @param {ConnectorsApiGetConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ getConnectorV1(requestParameters: ConnectorsApiGetConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a connector\'s correlation config using its script name. * @summary Update connector correlation configuration * @param {ConnectorsApiPutConnectorCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ putConnectorCorrelationConfigV1(requestParameters: ConnectorsApiPutConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a connector\'s source config using its script name. * @summary Update connector source configuration * @param {ConnectorsApiPutConnectorSourceConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ putConnectorSourceConfigV1(requestParameters: ConnectorsApiPutConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a connector\'s source template using its script name. * @summary Update connector source template * @param {ConnectorsApiPutConnectorSourceTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ putConnectorSourceTemplateV1(requestParameters: ConnectorsApiPutConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a connector\'s translations using its script name. * @summary Update connector translations * @param {ConnectorsApiPutConnectorTranslationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ putConnectorTranslationsV1(requestParameters: ConnectorsApiPutConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml * @summary Update connector by script name * @param {ConnectorsApiUpdateConnectorV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorsApi */ updateConnectorV1(requestParameters: ConnectorsApiUpdateConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetConnectorListV1LocaleEnum: { readonly De: "de"; readonly No: "no"; readonly Fi: "fi"; readonly Sv: "sv"; readonly Ru: "ru"; readonly Pt: "pt"; readonly Ko: "ko"; readonly ZhTw: "zh-TW"; readonly En: "en"; readonly It: "it"; readonly Fr: "fr"; readonly ZhCn: "zh-CN"; readonly Hu: "hu"; readonly Es: "es"; readonly Cs: "cs"; readonly Ja: "ja"; readonly Pl: "pl"; readonly Da: "da"; readonly Nl: "nl"; }; export type GetConnectorListV1LocaleEnum = typeof GetConnectorListV1LocaleEnum[keyof typeof GetConnectorListV1LocaleEnum]; /** * @export */ export declare const GetConnectorTranslationsV1LocaleEnum: { readonly De: "de"; readonly No: "no"; readonly Fi: "fi"; readonly Sv: "sv"; readonly Ru: "ru"; readonly Pt: "pt"; readonly Ko: "ko"; readonly ZhTw: "zh-TW"; readonly En: "en"; readonly It: "it"; readonly Fr: "fr"; readonly ZhCn: "zh-CN"; readonly Hu: "hu"; readonly Es: "es"; readonly Cs: "cs"; readonly Ja: "ja"; readonly Pl: "pl"; readonly Da: "da"; readonly Nl: "nl"; }; export type GetConnectorTranslationsV1LocaleEnum = typeof GetConnectorTranslationsV1LocaleEnum[keyof typeof GetConnectorTranslationsV1LocaleEnum]; /** * @export */ export declare const GetConnectorV1LocaleEnum: { readonly De: "de"; readonly No: "no"; readonly Fi: "fi"; readonly Sv: "sv"; readonly Ru: "ru"; readonly Pt: "pt"; readonly Ko: "ko"; readonly ZhTw: "zh-TW"; readonly En: "en"; readonly It: "it"; readonly Fr: "fr"; readonly ZhCn: "zh-CN"; readonly Hu: "hu"; readonly Es: "es"; readonly Cs: "cs"; readonly Ja: "ja"; readonly Pl: "pl"; readonly Da: "da"; readonly Nl: "nl"; }; export type GetConnectorV1LocaleEnum = typeof GetConnectorV1LocaleEnum[keyof typeof GetConnectorV1LocaleEnum]; /** * @export */ export declare const PutConnectorTranslationsV1LocaleEnum: { readonly De: "de"; readonly No: "no"; readonly Fi: "fi"; readonly Sv: "sv"; readonly Ru: "ru"; readonly Pt: "pt"; readonly Ko: "ko"; readonly ZhTw: "zh-TW"; readonly En: "en"; readonly It: "it"; readonly Fr: "fr"; readonly ZhCn: "zh-CN"; readonly Hu: "hu"; readonly Es: "es"; readonly Cs: "cs"; readonly Ja: "ja"; readonly Pl: "pl"; readonly Da: "da"; readonly Nl: "nl"; }; export type PutConnectorTranslationsV1LocaleEnum = typeof PutConnectorTranslationsV1LocaleEnum[keyof typeof PutConnectorTranslationsV1LocaleEnum];