/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Entitlement Connections * 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 { } /** * Entitlement connection entity returned by patch APIs. * @export * @interface EntitlementConnection */ export interface EntitlementConnection { /** * Tenant identifier that owns the connection. * @type {string} * @memberof EntitlementConnection */ 'tenantId'?: string; /** * Entitlement connection identifier. * @type {string} * @memberof EntitlementConnection */ 'connectionId'?: string; /** * Identity identifier associated with the connection. * @type {string} * @memberof EntitlementConnection */ 'identityId'?: string; /** * Machine identity identifier when the connection is machine-backed. * @type {string} * @memberof EntitlementConnection */ 'machineIdentityId'?: string; /** * Account identifier for the connected source account. * @type {string} * @memberof EntitlementConnection */ 'accountId'?: string; /** * Entitlement identifier on the source. * @type {string} * @memberof EntitlementConnection */ 'entitlementId'?: string; /** * Source identifier that provides the account and entitlement. * @type {string} * @memberof EntitlementConnection */ 'sourceId'?: string; /** * Indicates whether the connection is marked as standalone. * @type {boolean} * @memberof EntitlementConnection */ 'standalone'?: boolean; /** * Entitlement attribute name on the source. * @type {string} * @memberof EntitlementConnection */ 'attributeName'?: string; /** * Entitlement attribute value on the source. * @type {string} * @memberof EntitlementConnection */ 'attributeValue'?: string; /** * Connection type classification. * @type {string} * @memberof EntitlementConnection */ 'type'?: EntitlementConnectionTypeEnum; /** * Current lifecycle state of the connection. * @type {string} * @memberof EntitlementConnection */ 'state'?: string; /** * Time the connection state was last updated. * @type {string} * @memberof EntitlementConnection */ 'stateChanged'?: string; /** * Identifier of the actor that last changed state. * @type {string} * @memberof EntitlementConnection */ 'stateChangedBy'?: string; /** * Time JIT activation occurred. * @type {string} * @memberof EntitlementConnection */ 'jitActivation'?: string; /** * Time provisioning completed for JIT activation. * @type {string} * @memberof EntitlementConnection */ 'jitProvision'?: string; /** * Time JIT deactivation occurred. * @type {string} * @memberof EntitlementConnection */ 'jitDeactivation'?: string; /** * Time deprovisioning completed after JIT deactivation. * @type {string} * @memberof EntitlementConnection */ 'jitDeprovision'?: string; /** * Time when JIT access expires. * @type {string} * @memberof EntitlementConnection */ 'jitExpiration'?: string; /** * Time after which the connection is eligible for deletion. * @type {string} * @memberof EntitlementConnection */ 'deleteAfter'?: string; /** * Time when the connection was created. * @type {string} * @memberof EntitlementConnection */ 'created'?: string; /** * Time when the connection was last modified. * @type {string} * @memberof EntitlementConnection */ 'modified'?: string; /** * Display value for the actor associated with the latest change. * @type {string} * @memberof EntitlementConnection */ 'actorName'?: string; } export const EntitlementConnectionTypeEnum = { Jit: 'JIT', Standing: 'STANDING', Na: 'NA' } as const; export type EntitlementConnectionTypeEnum = typeof EntitlementConnectionTypeEnum[keyof typeof EntitlementConnectionTypeEnum]; /** * * @export * @interface EntitlementConnectionBulkUpdateItem */ export interface EntitlementConnectionBulkUpdateItem { /** * Connection ID to update. * @type {string} * @memberof EntitlementConnectionBulkUpdateItem */ 'connectionId': string; /** * Target connection type. * @type {string} * @memberof EntitlementConnectionBulkUpdateItem */ 'type': EntitlementConnectionBulkUpdateItemTypeEnum; } export const EntitlementConnectionBulkUpdateItemTypeEnum = { Jit: 'JIT', Standing: 'STANDING' } as const; export type EntitlementConnectionBulkUpdateItemTypeEnum = typeof EntitlementConnectionBulkUpdateItemTypeEnum[keyof typeof EntitlementConnectionBulkUpdateItemTypeEnum]; /** * * @export * @interface EntitlementConnectionBulkUpdateResultItem */ export interface EntitlementConnectionBulkUpdateResultItem { /** * Connection ID processed in this row. * @type {string} * @memberof EntitlementConnectionBulkUpdateResultItem */ 'connectionId'?: string; /** * Requested or resulting connection type for the row. * @type {string} * @memberof EntitlementConnectionBulkUpdateResultItem */ 'type'?: string; /** * Item-level result status code. * @type {number} * @memberof EntitlementConnectionBulkUpdateResultItem */ 'status'?: number; /** * Item-level result message. * @type {string} * @memberof EntitlementConnectionBulkUpdateResultItem */ 'description'?: string; } /** * Entitlement connection record returned by search-backed list endpoints. * @export * @interface EntitlementConnectionSearchHit */ export interface EntitlementConnectionSearchHit { /** * Connection ID as represented in search results. * @type {string} * @memberof EntitlementConnectionSearchHit */ 'id'?: string; /** * Identity summary object from search index. * @type {{ [key: string]: any; }} * @memberof EntitlementConnectionSearchHit */ 'identity'?: { [key: string]: any; }; /** * Machine identity summary object when available. * @type {{ [key: string]: any; }} * @memberof EntitlementConnectionSearchHit */ 'machineIdentity'?: { [key: string]: any; }; /** * Account summary object. * @type {{ [key: string]: any; }} * @memberof EntitlementConnectionSearchHit */ 'account'?: { [key: string]: any; }; /** * * @type {EntitlementConnectionSearchHitEntitlement} * @memberof EntitlementConnectionSearchHit */ 'entitlement'?: EntitlementConnectionSearchHitEntitlement; /** * Source summary object. * @type {{ [key: string]: any; }} * @memberof EntitlementConnectionSearchHit */ 'source'?: { [key: string]: any; }; /** * Connection state object. * @type {{ [key: string]: any; }} * @memberof EntitlementConnectionSearchHit */ 'state'?: { [key: string]: any; }; /** * JIT timestamps for lifecycle events. * @type {{ [key: string]: any; }} * @memberof EntitlementConnectionSearchHit */ 'jit'?: { [key: string]: any; }; /** * Indicates whether the connection is marked as standalone. * @type {boolean} * @memberof EntitlementConnectionSearchHit */ 'standalone'?: boolean; /** * Connection type classification. * @type {string} * @memberof EntitlementConnectionSearchHit */ 'type'?: EntitlementConnectionSearchHitTypeEnum; } export const EntitlementConnectionSearchHitTypeEnum = { Jit: 'JIT', Standing: 'STANDING', Na: 'NA' } as const; export type EntitlementConnectionSearchHitTypeEnum = typeof EntitlementConnectionSearchHitTypeEnum[keyof typeof EntitlementConnectionSearchHitTypeEnum]; /** * Entitlement object embedded in entitlement connection search responses. * @export * @interface EntitlementConnectionSearchHitEntitlement */ export interface EntitlementConnectionSearchHitEntitlement { /** * Entitlement identifier. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlement */ 'id'?: string; /** * Entitlement name. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlement */ 'name'?: string; /** * Human-readable entitlement label. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlement */ 'displayName'?: string; /** * Entitlement description. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlement */ 'description'?: string; /** * Source attribute carrying entitlement values. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlement */ 'attribute'?: string; /** * Source entitlement value. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlement */ 'value'?: string; /** * Source schema object type for the entitlement. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlement */ 'sourceSchemaObjectType'?: string; /** * * @type {EntitlementConnectionSearchHitEntitlementPrivilegeLevel} * @memberof EntitlementConnectionSearchHitEntitlement */ 'privilegeLevel'?: EntitlementConnectionSearchHitEntitlementPrivilegeLevel; } /** * Privilege classification details for the entitlement. * @export * @interface EntitlementConnectionSearchHitEntitlementPrivilegeLevel */ export interface EntitlementConnectionSearchHitEntitlementPrivilegeLevel { /** * Effective privilege level. * @type {string} * @memberof EntitlementConnectionSearchHitEntitlementPrivilegeLevel */ 'effective'?: string; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListEntitlementConnectionsV1401Response */ export interface ListEntitlementConnectionsV1401Response { /** * A message describing the error * @type {any} * @memberof ListEntitlementConnectionsV1401Response */ 'error'?: any; } /** * * @export * @interface ListEntitlementConnectionsV1412Response */ export interface ListEntitlementConnectionsV1412Response { /** * A message describing the error * @type {any} * @memberof ListEntitlementConnectionsV1412Response */ 'message'?: any; } /** * * @export * @interface ListEntitlementConnectionsV1429Response */ export interface ListEntitlementConnectionsV1429Response { /** * A message describing the error * @type {any} * @memberof ListEntitlementConnectionsV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * EntitlementConnectionsApi - axios parameter creator * @export */ export const EntitlementConnectionsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters. * @summary List my entitlement connections * @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} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. * @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listEntitlementConnectionsForCurrentIdentityV1: async (offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/entitlement-connections/v1/current-identity`; // 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 (searchAfter !== undefined) { localVarQueryParameter['searchAfter'] = searchAfter; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS. * @summary List entitlement connections * @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} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. * @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listEntitlementConnectionsV1: async (offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/entitlement-connections/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 (searchAfter !== undefined) { localVarQueryParameter['searchAfter'] = searchAfter; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Applies JSON Patch operations to an entitlement connection selected by `connectionId`. * @summary Update entitlement connection * @param {string} connectionId Connection ID (UUID with or without hyphens). * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchEntitlementConnectionByIdV1: async (connectionId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'connectionId' is not null or undefined assertParamExists('patchEntitlementConnectionByIdV1', 'connectionId', connectionId) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchEntitlementConnectionByIdV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/entitlement-connections/v1/{connectionId}` .replace(`{${"connectionId"}}`, encodeURIComponent(String(connectionId))); // 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, }; }, /** * Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`. * @summary Update connection by query * @param {string} entitlementId Entitlement ID (UUID with or without hyphens). * @param {string} identityId Identity ID (UUID with or without hyphens). * @param {string} accountId Account ID (UUID with or without hyphens). * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchEntitlementConnectionByQueryV1: async (entitlementId: string, identityId: string, accountId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'entitlementId' is not null or undefined assertParamExists('patchEntitlementConnectionByQueryV1', 'entitlementId', entitlementId) // verify required parameter 'identityId' is not null or undefined assertParamExists('patchEntitlementConnectionByQueryV1', 'identityId', identityId) // verify required parameter 'accountId' is not null or undefined assertParamExists('patchEntitlementConnectionByQueryV1', 'accountId', accountId) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchEntitlementConnectionByQueryV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/entitlement-connections/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: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (entitlementId !== undefined) { localVarQueryParameter['entitlementId'] = entitlementId; } if (identityId !== undefined) { localVarQueryParameter['identityId'] = identityId; } if (accountId !== undefined) { localVarQueryParameter['accountId'] = accountId; } 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, }; }, /** * Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response. * @summary Update connections in bulk * @param {Array} entitlementConnectionBulkUpdateItem * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateEntitlementConnectionsBulkV1: async (entitlementConnectionBulkUpdateItem: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'entitlementConnectionBulkUpdateItem' is not null or undefined assertParamExists('updateEntitlementConnectionsBulkV1', 'entitlementConnectionBulkUpdateItem', entitlementConnectionBulkUpdateItem) const localVarPath = `/entitlement-connections/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(entitlementConnectionBulkUpdateItem, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * EntitlementConnectionsApi - functional programming interface * @export */ export const EntitlementConnectionsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = EntitlementConnectionsApiAxiosParamCreator(configuration) return { /** * Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters. * @summary List my entitlement connections * @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} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. * @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listEntitlementConnectionsForCurrentIdentityV1(offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementConnectionsForCurrentIdentityV1(offset, limit, count, searchAfter, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsApi.listEntitlementConnectionsForCurrentIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS. * @summary List entitlement connections * @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} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. * @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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listEntitlementConnectionsV1(offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementConnectionsV1(offset, limit, count, searchAfter, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsApi.listEntitlementConnectionsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Applies JSON Patch operations to an entitlement connection selected by `connectionId`. * @summary Update entitlement connection * @param {string} connectionId Connection ID (UUID with or without hyphens). * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchEntitlementConnectionByIdV1(connectionId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementConnectionByIdV1(connectionId, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsApi.patchEntitlementConnectionByIdV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`. * @summary Update connection by query * @param {string} entitlementId Entitlement ID (UUID with or without hyphens). * @param {string} identityId Identity ID (UUID with or without hyphens). * @param {string} accountId Account ID (UUID with or without hyphens). * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchEntitlementConnectionByQueryV1(entitlementId: string, identityId: string, accountId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementConnectionByQueryV1(entitlementId, identityId, accountId, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsApi.patchEntitlementConnectionByQueryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response. * @summary Update connections in bulk * @param {Array} entitlementConnectionBulkUpdateItem * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateEntitlementConnectionsBulkV1(entitlementConnectionBulkUpdateItem: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementConnectionsBulkV1(entitlementConnectionBulkUpdateItem, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsApi.updateEntitlementConnectionsBulkV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * EntitlementConnectionsApi - factory interface * @export */ export const EntitlementConnectionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = EntitlementConnectionsApiFp(configuration) return { /** * Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters. * @summary List my entitlement connections * @param {EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listEntitlementConnectionsForCurrentIdentityV1(requestParameters: EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listEntitlementConnectionsForCurrentIdentityV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS. * @summary List entitlement connections * @param {EntitlementConnectionsApiListEntitlementConnectionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listEntitlementConnectionsV1(requestParameters: EntitlementConnectionsApiListEntitlementConnectionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listEntitlementConnectionsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Applies JSON Patch operations to an entitlement connection selected by `connectionId`. * @summary Update entitlement connection * @param {EntitlementConnectionsApiPatchEntitlementConnectionByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchEntitlementConnectionByIdV1(requestParameters: EntitlementConnectionsApiPatchEntitlementConnectionByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchEntitlementConnectionByIdV1(requestParameters.connectionId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`. * @summary Update connection by query * @param {EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchEntitlementConnectionByQueryV1(requestParameters: EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchEntitlementConnectionByQueryV1(requestParameters.entitlementId, requestParameters.identityId, requestParameters.accountId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response. * @summary Update connections in bulk * @param {EntitlementConnectionsApiUpdateEntitlementConnectionsBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateEntitlementConnectionsBulkV1(requestParameters: EntitlementConnectionsApiUpdateEntitlementConnectionsBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.updateEntitlementConnectionsBulkV1(requestParameters.entitlementConnectionBulkUpdateItem, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for listEntitlementConnectionsForCurrentIdentityV1 operation in EntitlementConnectionsApi. * @export * @interface EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1Request */ export interface EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1Request { /** * 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 EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1 */ 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 EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1 */ 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 EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1 */ readonly count?: boolean /** * Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. * @type {string} * @memberof EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1 */ readonly searchAfter?: string /** * 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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service. * @type {string} * @memberof EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** * @type {string} * @memberof EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1 */ readonly sorters?: string } /** * Request parameters for listEntitlementConnectionsV1 operation in EntitlementConnectionsApi. * @export * @interface EntitlementConnectionsApiListEntitlementConnectionsV1Request */ export interface EntitlementConnectionsApiListEntitlementConnectionsV1Request { /** * 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 EntitlementConnectionsApiListEntitlementConnectionsV1 */ 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 EntitlementConnectionsApiListEntitlementConnectionsV1 */ 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 EntitlementConnectionsApiListEntitlementConnectionsV1 */ readonly count?: boolean /** * Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. * @type {string} * @memberof EntitlementConnectionsApiListEntitlementConnectionsV1 */ readonly searchAfter?: string /** * 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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* * @type {string} * @memberof EntitlementConnectionsApiListEntitlementConnectionsV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order. * @type {string} * @memberof EntitlementConnectionsApiListEntitlementConnectionsV1 */ readonly sorters?: string } /** * Request parameters for patchEntitlementConnectionByIdV1 operation in EntitlementConnectionsApi. * @export * @interface EntitlementConnectionsApiPatchEntitlementConnectionByIdV1Request */ export interface EntitlementConnectionsApiPatchEntitlementConnectionByIdV1Request { /** * Connection ID (UUID with or without hyphens). * @type {string} * @memberof EntitlementConnectionsApiPatchEntitlementConnectionByIdV1 */ readonly connectionId: string /** * * @type {Array} * @memberof EntitlementConnectionsApiPatchEntitlementConnectionByIdV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for patchEntitlementConnectionByQueryV1 operation in EntitlementConnectionsApi. * @export * @interface EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1Request */ export interface EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1Request { /** * Entitlement ID (UUID with or without hyphens). * @type {string} * @memberof EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1 */ readonly entitlementId: string /** * Identity ID (UUID with or without hyphens). * @type {string} * @memberof EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1 */ readonly identityId: string /** * Account ID (UUID with or without hyphens). * @type {string} * @memberof EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1 */ readonly accountId: string /** * * @type {Array} * @memberof EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for updateEntitlementConnectionsBulkV1 operation in EntitlementConnectionsApi. * @export * @interface EntitlementConnectionsApiUpdateEntitlementConnectionsBulkV1Request */ export interface EntitlementConnectionsApiUpdateEntitlementConnectionsBulkV1Request { /** * * @type {Array} * @memberof EntitlementConnectionsApiUpdateEntitlementConnectionsBulkV1 */ readonly entitlementConnectionBulkUpdateItem: Array } /** * EntitlementConnectionsApi - object-oriented interface * @export * @class EntitlementConnectionsApi * @extends {BaseAPI} */ export class EntitlementConnectionsApi extends BaseAPI { /** * Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters. * @summary List my entitlement connections * @param {EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof EntitlementConnectionsApi */ public listEntitlementConnectionsForCurrentIdentityV1(requestParameters: EntitlementConnectionsApiListEntitlementConnectionsForCurrentIdentityV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return EntitlementConnectionsApiFp(this.configuration).listEntitlementConnectionsForCurrentIdentityV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Returns entitlement connections for the tenant. This endpoint proxies to Search and supports standard collection query parameters. The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS. * @summary List entitlement connections * @param {EntitlementConnectionsApiListEntitlementConnectionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof EntitlementConnectionsApi */ public listEntitlementConnectionsV1(requestParameters: EntitlementConnectionsApiListEntitlementConnectionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return EntitlementConnectionsApiFp(this.configuration).listEntitlementConnectionsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Applies JSON Patch operations to an entitlement connection selected by `connectionId`. * @summary Update entitlement connection * @param {EntitlementConnectionsApiPatchEntitlementConnectionByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof EntitlementConnectionsApi */ public patchEntitlementConnectionByIdV1(requestParameters: EntitlementConnectionsApiPatchEntitlementConnectionByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { return EntitlementConnectionsApiFp(this.configuration).patchEntitlementConnectionByIdV1(requestParameters.connectionId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Applies JSON Patch operations to a single entitlement connection selected by `entitlementId`, `identityId`, and `accountId`. * @summary Update connection by query * @param {EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof EntitlementConnectionsApi */ public patchEntitlementConnectionByQueryV1(requestParameters: EntitlementConnectionsApiPatchEntitlementConnectionByQueryV1Request, axiosOptions?: RawAxiosRequestConfig) { return EntitlementConnectionsApiFp(this.configuration).patchEntitlementConnectionByQueryV1(requestParameters.entitlementId, requestParameters.identityId, requestParameters.accountId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response. * @summary Update connections in bulk * @param {EntitlementConnectionsApiUpdateEntitlementConnectionsBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof EntitlementConnectionsApi */ public updateEntitlementConnectionsBulkV1(requestParameters: EntitlementConnectionsApiUpdateEntitlementConnectionsBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { return EntitlementConnectionsApiFp(this.configuration).updateEntitlementConnectionsBulkV1(requestParameters.entitlementConnectionBulkUpdateItem, axiosOptions).then((request) => request(this.axios, this.basePath)); } }