/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Managed Clients * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface 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 GetManagedClientsV1401Response */ export interface GetManagedClientsV1401Response { /** * A message describing the error * @type {any} * @memberof GetManagedClientsV1401Response */ 'error'?: any; } /** * * @export * @interface GetManagedClientsV1429Response */ export interface GetManagedClientsV1429Response { /** * A message describing the error * @type {any} * @memberof GetManagedClientsV1429Response */ 'message'?: any; } /** * Individual error or warning event * @export * @interface HealthEvent */ export interface HealthEvent { /** * Description of the issue * @type {string} * @memberof HealthEvent */ 'detailedMessage'?: string; /** * Unique identifier for the health event * @type {string} * @memberof HealthEvent */ 'uuid'?: string; /** * Optional URL associated with the issue * @type {string} * @memberof HealthEvent */ 'url'?: string | null; /** * Time when the event occurred * @type {string} * @memberof HealthEvent */ 'timestamp'?: string; /** * Last time notification was sent for this issue * @type {string} * @memberof HealthEvent */ 'lastNotifiedTimeStamp'?: string; /** * CPU usage percentage * @type {number} * @memberof HealthEvent */ 'cpuUtilizationPercentage'?: number | null; /** * Free memory percentage * @type {number} * @memberof HealthEvent */ 'freeSpacePercentage'?: number | null; } /** * Health indicator category data with errors and warnings * @export * @interface HealthIndicatorCategory */ export interface HealthIndicatorCategory { /** * List of error events for this category * @type {Array} * @memberof HealthIndicatorCategory */ 'errors'?: Array; /** * List of warning events for this category * @type {Array} * @memberof HealthIndicatorCategory */ 'warnings'?: Array; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * 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]; /** * Managed Client * @export * @interface ManagedClient */ export interface ManagedClient { /** * ManagedClient ID * @type {string} * @memberof ManagedClient */ 'id'?: string | null; /** * ManagedClient alert key * @type {string} * @memberof ManagedClient */ 'alertKey'?: string | null; /** * * @type {string} * @memberof ManagedClient */ 'apiGatewayBaseUrl'?: string | null; /** * * @type {string} * @memberof ManagedClient */ 'cookbook'?: string | null; /** * Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) * @type {number} * @memberof ManagedClient */ 'ccId'?: number | null; /** * The client ID used in API management * @type {string} * @memberof ManagedClient */ 'clientId': string; /** * Cluster ID that the ManagedClient is linked to * @type {string} * @memberof ManagedClient */ 'clusterId': string; /** * ManagedClient description * @type {string} * @memberof ManagedClient */ 'description': string; /** * The public IP address of the ManagedClient * @type {string} * @memberof ManagedClient */ 'ipAddress'?: string | null; /** * When the ManagedClient was last seen by the server * @type {string} * @memberof ManagedClient */ 'lastSeen'?: string | null; /** * ManagedClient name * @type {string} * @memberof ManagedClient */ 'name'?: string | null; /** * Milliseconds since the ManagedClient has polled the server * @type {string} * @memberof ManagedClient */ 'sinceLastSeen'?: string | null; /** * Status of the ManagedClient * @type {string} * @memberof ManagedClient */ 'status'?: ManagedClientStatusEnum | null; /** * Type of the ManagedClient (VA, CCG) * @type {string} * @memberof ManagedClient */ 'type': string; /** * Cluster Type of the ManagedClient * @type {string} * @memberof ManagedClient */ 'clusterType'?: ManagedClientClusterTypeEnum | null; /** * ManagedClient VA download URL * @type {string} * @memberof ManagedClient */ 'vaDownloadUrl'?: string | null; /** * Version that the ManagedClient\'s VA is running * @type {string} * @memberof ManagedClient */ 'vaVersion'?: string | null; /** * Client\'s apiKey * @type {string} * @memberof ManagedClient */ 'secret'?: string | null; /** * The date/time this ManagedClient was created * @type {string} * @memberof ManagedClient */ 'createdAt'?: string | null; /** * The date/time this ManagedClient was last updated * @type {string} * @memberof ManagedClient */ 'updatedAt'?: string | null; /** * The provisioning status of the ManagedClient * @type {string} * @memberof ManagedClient */ 'provisionStatus'?: ManagedClientProvisionStatusEnum | null; } export const ManagedClientStatusEnum = { Normal: 'NORMAL', Undefined: 'UNDEFINED', NotConfigured: 'NOT_CONFIGURED', Configuring: 'CONFIGURING', Warning: 'WARNING', Error: 'ERROR', Failed: 'FAILED' } as const; export type ManagedClientStatusEnum = typeof ManagedClientStatusEnum[keyof typeof ManagedClientStatusEnum]; export const ManagedClientClusterTypeEnum = { Idn: 'idn', Iai: 'iai', SpConnectCluster: 'spConnectCluster', SqsCluster: 'sqsCluster', DasRc: 'das-rc', DasPc: 'das-pc', DasDc: 'das-dc' } as const; export type ManagedClientClusterTypeEnum = typeof ManagedClientClusterTypeEnum[keyof typeof ManagedClientClusterTypeEnum]; export const ManagedClientProvisionStatusEnum = { Provisioned: 'PROVISIONED', Draft: 'DRAFT' } as const; export type ManagedClientProvisionStatusEnum = typeof ManagedClientProvisionStatusEnum[keyof typeof ManagedClientProvisionStatusEnum]; /** * Health Indicators for a Managed Client * @export * @interface ManagedClientHealthIndicators */ export interface ManagedClientHealthIndicators { /** * * @type {ManagedClientHealthIndicatorsBody} * @memberof ManagedClientHealthIndicators */ 'body': ManagedClientHealthIndicatorsBody; /** * Top-level status of the Managed Client * @type {string} * @memberof ManagedClientHealthIndicators */ 'status': ManagedClientHealthIndicatorsStatusEnum; /** * Type of the Managed Client * @type {string} * @memberof ManagedClientHealthIndicators */ 'type': ManagedClientHealthIndicatorsTypeEnum; /** * Timestamp when this report was generated * @type {string} * @memberof ManagedClientHealthIndicators */ 'timestamp': string; } export const ManagedClientHealthIndicatorsStatusEnum = { Normal: 'NORMAL', Undefined: 'UNDEFINED', Warning: 'WARNING', Error: 'ERROR', Failed: 'FAILED' } as const; export type ManagedClientHealthIndicatorsStatusEnum = typeof ManagedClientHealthIndicatorsStatusEnum[keyof typeof ManagedClientHealthIndicatorsStatusEnum]; export const ManagedClientHealthIndicatorsTypeEnum = { Va: 'VA', Ccg: 'CCG' } as const; export type ManagedClientHealthIndicatorsTypeEnum = typeof ManagedClientHealthIndicatorsTypeEnum[keyof typeof ManagedClientHealthIndicatorsTypeEnum]; /** * Health indicator details from the Managed Client * @export * @interface ManagedClientHealthIndicatorsBody */ export interface ManagedClientHealthIndicatorsBody { /** * Health indicator alert key * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'alertKey'?: string | null; /** * Unique identifier for the health report * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'id': string; /** * Cluster ID the health report belongs to * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'clusterId': string; /** * API user ID sending the health data * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'apiUser': string; /** * ETag value for CCG version control * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'ccg_etag'?: string | null; /** * PIN value for CCG validation * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'ccg_pin'?: string | null; /** * ETag for cookbook version * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'cookbook_etag'?: string | null; /** * Hostname of the Managed Client * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'hostname': string; /** * Internal IP address of the Managed Client * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'internal_ip'?: string; /** * Epoch timestamp (in millis) when last seen * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'lastSeen'?: string; /** * Seconds since last seen * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'sinceSeen'?: string; /** * Milliseconds since last seen * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'sinceSeenMillis'?: string; /** * Indicates if this is a local development instance * @type {boolean} * @memberof ManagedClientHealthIndicatorsBody */ 'localDev'?: boolean; /** * Stacktrace associated with any error, if available * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'stacktrace'?: string | null; /** * Optional state value from the client * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'state'?: string | null; /** * Status of the client at the time of report * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'status': ManagedClientHealthIndicatorsBodyStatusEnum; /** * Optional UUID from the client * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'uuid'?: string | null; /** * Product type (e.g., idn) * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'product': string; /** * VA version installed on the client * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'va_version'?: string | null; /** * Version of the platform on which VA is running * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'platform_version': string; /** * Operating system version * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'os_version': string; /** * Operating system type * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'os_type': string; /** * Virtualization platform used * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'hypervisor': string; /** * Consolidated health indicator status * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'consolidatedHealthIndicatorsStatus': ManagedClientHealthIndicatorsBodyConsolidatedHealthIndicatorsStatusEnum; /** * The last CCG version for which notification was sent * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'lastNotifiedCcgVersion'?: string; /** * Information about deployed processes * @type {string} * @memberof ManagedClientHealthIndicatorsBody */ 'deployed_processes'?: string | null; /** * * @type {ManagedClientHealthIndicatorsBodyHealthIndicators} * @memberof ManagedClientHealthIndicatorsBody */ 'health_indicators': ManagedClientHealthIndicatorsBodyHealthIndicators; } export const ManagedClientHealthIndicatorsBodyStatusEnum = { Normal: 'NORMAL', Undefined: 'UNDEFINED', Warning: 'WARNING', Error: 'ERROR', Failed: 'FAILED' } as const; export type ManagedClientHealthIndicatorsBodyStatusEnum = typeof ManagedClientHealthIndicatorsBodyStatusEnum[keyof typeof ManagedClientHealthIndicatorsBodyStatusEnum]; export const ManagedClientHealthIndicatorsBodyConsolidatedHealthIndicatorsStatusEnum = { Normal: 'NORMAL', Warning: 'WARNING', Error: 'ERROR' } as const; export type ManagedClientHealthIndicatorsBodyConsolidatedHealthIndicatorsStatusEnum = typeof ManagedClientHealthIndicatorsBodyConsolidatedHealthIndicatorsStatusEnum[keyof typeof ManagedClientHealthIndicatorsBodyConsolidatedHealthIndicatorsStatusEnum]; /** * Health indicators grouped by category * @export * @interface ManagedClientHealthIndicatorsBodyHealthIndicators */ export interface ManagedClientHealthIndicatorsBodyHealthIndicators { /** * * @type {HealthIndicatorCategory} * @memberof ManagedClientHealthIndicatorsBodyHealthIndicators */ 'container'?: HealthIndicatorCategory; /** * * @type {HealthIndicatorCategory} * @memberof ManagedClientHealthIndicatorsBodyHealthIndicators */ 'memory'?: HealthIndicatorCategory; /** * * @type {HealthIndicatorCategory} * @memberof ManagedClientHealthIndicatorsBodyHealthIndicators */ 'cpu'?: HealthIndicatorCategory; } /** * Managed Client Request * @export * @interface ManagedClientRequest */ export interface ManagedClientRequest { /** * Cluster ID that the ManagedClient is linked to * @type {string} * @memberof ManagedClientRequest */ 'clusterId': string; /** * description for the ManagedClient to create * @type {string} * @memberof ManagedClientRequest */ 'description'?: string | null; /** * name for the ManagedClient to create * @type {string} * @memberof ManagedClientRequest */ 'name'?: string | null; /** * Type of the ManagedClient (VA, CCG) to create * @type {string} * @memberof ManagedClientRequest */ 'type'?: string | null; } /** * Managed Client Status * @export * @interface ManagedClientStatus */ export interface ManagedClientStatus { /** * ManagedClientStatus body information * @type {object} * @memberof ManagedClientStatus */ 'body': object; /** * * @type {ManagedClientStatusCode} * @memberof ManagedClientStatus */ 'status': ManagedClientStatusCode; /** * * @type {ManagedClientType} * @memberof ManagedClientStatus */ 'type': ManagedClientType | null; /** * timestamp on the Client Status update * @type {string} * @memberof ManagedClientStatus */ 'timestamp': string; } /** * Status of a Managed Client * @export * @enum {string} */ export const ManagedClientStatusCode = { Normal: 'NORMAL', Undefined: 'UNDEFINED', NotConfigured: 'NOT_CONFIGURED', Configuring: 'CONFIGURING', Warning: 'WARNING', Error: 'ERROR', Failed: 'FAILED' } as const; export type ManagedClientStatusCode = typeof ManagedClientStatusCode[keyof typeof ManagedClientStatusCode]; /** * Managed Client type * @export * @enum {string} */ export const ManagedClientType = { Ccg: 'CCG', Va: 'VA', Internal: 'INTERNAL', IiqHarvester: 'IIQ_HARVESTER' } as const; export type ManagedClientType = typeof ManagedClientType[keyof typeof ManagedClientType]; /** * ManagedClientsApi - axios parameter creator * @export */ export const ManagedClientsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Create a new managed client. The API returns a result that includes the managed client ID. * @summary Create managed client * @param {ManagedClientRequest} managedClientRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createManagedClientV1: async (managedClientRequest: ManagedClientRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'managedClientRequest' is not null or undefined assertParamExists('createManagedClientV1', 'managedClientRequest', managedClientRequest) const localVarPath = `/managed-clients/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(managedClientRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Delete an existing managed client. * @summary Delete managed client * @param {string} id Managed client ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteManagedClientV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteManagedClientV1', 'id', id) const localVarPath = `/managed-clients/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get a managed client\'s health indicators, using its ID. * @summary Get managed client health indicators * @param {string} id Managed client ID to get health indicators for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientHealthIndicatorsV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getManagedClientHealthIndicatorsV1', 'id', id) const localVarPath = `/managed-clients/v1/{id}/health-indicators` .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, }; }, /** * Get a managed client\'s status, using its ID. * @summary Get managed client status * @param {string} id Managed client ID to get status for. * @param {ManagedClientType} type Managed client type to get status for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientStatusV1: async (id: string, type: ManagedClientType, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getManagedClientStatusV1', 'id', id) // verify required parameter 'type' is not null or undefined assertParamExists('getManagedClientStatusV1', 'type', type) const localVarPath = `/managed-clients/v1/{id}/status` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (type !== undefined) { localVarQueryParameter['type'] = type; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get managed client by ID. * @summary Get managed client * @param {string} id Managed client ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getManagedClientV1', 'id', id) const localVarPath = `/managed-clients/v1/{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, }; }, /** * List managed clients. * @summary Get managed clients * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientsV1: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/managed-clients/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Update an existing managed client. * @summary Update managed client * @param {string} id Managed client ID. * @param {Array} jsonPatchOperation JSONPatch payload used to update the object. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateManagedClientV1: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('updateManagedClientV1', 'id', id) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('updateManagedClientV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/managed-clients/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * ManagedClientsApi - functional programming interface * @export */ export const ManagedClientsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ManagedClientsApiAxiosParamCreator(configuration) return { /** * Create a new managed client. The API returns a result that includes the managed client ID. * @summary Create managed client * @param {ManagedClientRequest} managedClientRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createManagedClientV1(managedClientRequest: ManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClientV1(managedClientRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.createManagedClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Delete an existing managed client. * @summary Delete managed client * @param {string} id Managed client ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteManagedClientV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClientV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.deleteManagedClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a managed client\'s health indicators, using its ID. * @summary Get managed client health indicators * @param {string} id Managed client ID to get health indicators for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getManagedClientHealthIndicatorsV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientHealthIndicatorsV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.getManagedClientHealthIndicatorsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a managed client\'s status, using its ID. * @summary Get managed client status * @param {string} id Managed client ID to get status for. * @param {ManagedClientType} type Managed client type to get status for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getManagedClientStatusV1(id: string, type: ManagedClientType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientStatusV1(id, type, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.getManagedClientStatusV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get managed client by ID. * @summary Get managed client * @param {string} id Managed client ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getManagedClientV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.getManagedClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * List managed clients. * @summary Get managed clients * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getManagedClientsV1(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientsV1(offset, limit, count, filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.getManagedClientsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update an existing managed client. * @summary Update managed client * @param {string} id Managed client ID. * @param {Array} jsonPatchOperation JSONPatch payload used to update the object. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateManagedClientV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClientV1(id, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.updateManagedClientV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * ManagedClientsApi - factory interface * @export */ export const ManagedClientsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ManagedClientsApiFp(configuration) return { /** * Create a new managed client. The API returns a result that includes the managed client ID. * @summary Create managed client * @param {ManagedClientsApiCreateManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createManagedClientV1(requestParameters: ManagedClientsApiCreateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createManagedClientV1(requestParameters.managedClientRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * Delete an existing managed client. * @summary Delete managed client * @param {ManagedClientsApiDeleteManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteManagedClientV1(requestParameters: ManagedClientsApiDeleteManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteManagedClientV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a managed client\'s health indicators, using its ID. * @summary Get managed client health indicators * @param {ManagedClientsApiGetManagedClientHealthIndicatorsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientHealthIndicatorsV1(requestParameters: ManagedClientsApiGetManagedClientHealthIndicatorsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getManagedClientHealthIndicatorsV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a managed client\'s status, using its ID. * @summary Get managed client status * @param {ManagedClientsApiGetManagedClientStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientStatusV1(requestParameters: ManagedClientsApiGetManagedClientStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getManagedClientStatusV1(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get managed client by ID. * @summary Get managed client * @param {ManagedClientsApiGetManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientV1(requestParameters: ManagedClientsApiGetManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getManagedClientV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * List managed clients. * @summary Get managed clients * @param {ManagedClientsApiGetManagedClientsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getManagedClientsV1(requestParameters: ManagedClientsApiGetManagedClientsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getManagedClientsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Update an existing managed client. * @summary Update managed client * @param {ManagedClientsApiUpdateManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateManagedClientV1(requestParameters: ManagedClientsApiUpdateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateManagedClientV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createManagedClientV1 operation in ManagedClientsApi. * @export * @interface ManagedClientsApiCreateManagedClientV1Request */ export interface ManagedClientsApiCreateManagedClientV1Request { /** * * @type {ManagedClientRequest} * @memberof ManagedClientsApiCreateManagedClientV1 */ readonly managedClientRequest: ManagedClientRequest } /** * Request parameters for deleteManagedClientV1 operation in ManagedClientsApi. * @export * @interface ManagedClientsApiDeleteManagedClientV1Request */ export interface ManagedClientsApiDeleteManagedClientV1Request { /** * Managed client ID. * @type {string} * @memberof ManagedClientsApiDeleteManagedClientV1 */ readonly id: string } /** * Request parameters for getManagedClientHealthIndicatorsV1 operation in ManagedClientsApi. * @export * @interface ManagedClientsApiGetManagedClientHealthIndicatorsV1Request */ export interface ManagedClientsApiGetManagedClientHealthIndicatorsV1Request { /** * Managed client ID to get health indicators for. * @type {string} * @memberof ManagedClientsApiGetManagedClientHealthIndicatorsV1 */ readonly id: string } /** * Request parameters for getManagedClientStatusV1 operation in ManagedClientsApi. * @export * @interface ManagedClientsApiGetManagedClientStatusV1Request */ export interface ManagedClientsApiGetManagedClientStatusV1Request { /** * Managed client ID to get status for. * @type {string} * @memberof ManagedClientsApiGetManagedClientStatusV1 */ readonly id: string /** * Managed client type to get status for. * @type {ManagedClientType} * @memberof ManagedClientsApiGetManagedClientStatusV1 */ readonly type: ManagedClientType } /** * Request parameters for getManagedClientV1 operation in ManagedClientsApi. * @export * @interface ManagedClientsApiGetManagedClientV1Request */ export interface ManagedClientsApiGetManagedClientV1Request { /** * Managed client ID. * @type {string} * @memberof ManagedClientsApiGetManagedClientV1 */ readonly id: string } /** * Request parameters for getManagedClientsV1 operation in ManagedClientsApi. * @export * @interface ManagedClientsApiGetManagedClientsV1Request */ export interface ManagedClientsApiGetManagedClientsV1Request { /** * 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 ManagedClientsApiGetManagedClientsV1 */ readonly offset?: number /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ManagedClientsApiGetManagedClientsV1 */ readonly limit?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof ManagedClientsApiGetManagedClientsV1 */ readonly count?: boolean /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* * @type {string} * @memberof ManagedClientsApiGetManagedClientsV1 */ readonly filters?: string } /** * Request parameters for updateManagedClientV1 operation in ManagedClientsApi. * @export * @interface ManagedClientsApiUpdateManagedClientV1Request */ export interface ManagedClientsApiUpdateManagedClientV1Request { /** * Managed client ID. * @type {string} * @memberof ManagedClientsApiUpdateManagedClientV1 */ readonly id: string /** * JSONPatch payload used to update the object. * @type {Array} * @memberof ManagedClientsApiUpdateManagedClientV1 */ readonly jsonPatchOperation: Array } /** * ManagedClientsApi - object-oriented interface * @export * @class ManagedClientsApi * @extends {BaseAPI} */ export class ManagedClientsApi extends BaseAPI { /** * Create a new managed client. The API returns a result that includes the managed client ID. * @summary Create managed client * @param {ManagedClientsApiCreateManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ManagedClientsApi */ public createManagedClientV1(requestParameters: ManagedClientsApiCreateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return ManagedClientsApiFp(this.configuration).createManagedClientV1(requestParameters.managedClientRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Delete an existing managed client. * @summary Delete managed client * @param {ManagedClientsApiDeleteManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ManagedClientsApi */ public deleteManagedClientV1(requestParameters: ManagedClientsApiDeleteManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return ManagedClientsApiFp(this.configuration).deleteManagedClientV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a managed client\'s health indicators, using its ID. * @summary Get managed client health indicators * @param {ManagedClientsApiGetManagedClientHealthIndicatorsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ManagedClientsApi */ public getManagedClientHealthIndicatorsV1(requestParameters: ManagedClientsApiGetManagedClientHealthIndicatorsV1Request, axiosOptions?: RawAxiosRequestConfig) { return ManagedClientsApiFp(this.configuration).getManagedClientHealthIndicatorsV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a managed client\'s status, using its ID. * @summary Get managed client status * @param {ManagedClientsApiGetManagedClientStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ManagedClientsApi */ public getManagedClientStatusV1(requestParameters: ManagedClientsApiGetManagedClientStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { return ManagedClientsApiFp(this.configuration).getManagedClientStatusV1(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get managed client by ID. * @summary Get managed client * @param {ManagedClientsApiGetManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ManagedClientsApi */ public getManagedClientV1(requestParameters: ManagedClientsApiGetManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return ManagedClientsApiFp(this.configuration).getManagedClientV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * List managed clients. * @summary Get managed clients * @param {ManagedClientsApiGetManagedClientsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ManagedClientsApi */ public getManagedClientsV1(requestParameters: ManagedClientsApiGetManagedClientsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return ManagedClientsApiFp(this.configuration).getManagedClientsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update an existing managed client. * @summary Update managed client * @param {ManagedClientsApiUpdateManagedClientV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ManagedClientsApi */ public updateManagedClientV1(requestParameters: ManagedClientsApiUpdateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { return ManagedClientsApiFp(this.configuration).updateManagedClientV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } }